PHPackages                             futurfuturfuturfutur/duckduckduck - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. futurfuturfuturfutur/duckduckduck

AbandonedArchivedPackage[API Development](/categories/api)

futurfuturfuturfutur/duckduckduck
=================================

Laravel package able to auto generate API documentation through tests, without garbage comments inside the code base.

1.0.3(4y ago)2313MITPHP

Since Mar 29Pushed 4y ago1 watchersCompare

[ Source](https://github.com/futurfuturfuturfutur/duckduckduck)[ Packagist](https://packagist.org/packages/futurfuturfuturfutur/duckduckduck)[ RSS](/packages/futurfuturfuturfutur-duckduckduck/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (2)Versions (5)Used By (0)

🦆 DuckDuckDuck
==============

[](#-duckduckduck)

[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)![Travis](https://camo.githubusercontent.com/cd98708a34c186e36f9b17b3dbe1e62b573823f038d4f41145cdeafa25b2afef/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f66757475726675747572667574757266757475722f6475636b6475636b6475636b2e7376673f7374796c653d666c61742d737175617265)[![Total Downloads](https://camo.githubusercontent.com/8feb79cd959eb342f453730c03a5e6c1d019c9c6d0a534b66d63b95c3e88d752/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f66757475726675747572667574757266757475722f6475636b6475636b6475636b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/futurfuturfuturfutur/duckduckduck)

Laravel package able to auto generate API documentation through tests, without garbage comments inside the code base.

Support of documentations
-------------------------

[](#support-of-documentations)

1. OpenAPI 3.0.0

How it works
------------

[](#how-it-works)

If your project has excellent feature testing coverage, it means you already has documentation for this project. You've already described available paths, requests body, parameters, content types, response payloads and http codes. You shouldn't describe it again by your own just in format of the api documentation you use.The package principle is super simple: when you run tests, package middleware just grab response and request of the test case and saves it as an api documentation config file, which you can use to render.

Install
-------

[](#install)

1. Install package with `composer require --dev futurfuturfuturfutur/duckduckduck`
2. Publish and setup package with `php artisan duckduckduck:init`. This command will publish duckduckduck.php configuration file inside the `config` folder of Laravel with base configuration of your API documentation and create `/duckduckduck`package dir inside the root of the app to contain all documentation configs of your project generated by package.
3. Add TestCase trait inside the phpunit TestCase ```