Jadd : Another Documentation Dumper, (*1)
- Because we love reading documentation on REST API.
- We really don't like writing documentation.
- We really don't like updating documentation.
- Annotations are evil
2 steps are needed, (*2)
Collect the responses during functional tests
Of course you have tests for your API. So why not connecting to it and record all the cases you test ?, (*3)
If you use php-http, we provide a middleware to collect the data during your tests. Have a look on the test to be sure how to use it., (*4)
Consolidate routing file
Then just need to run the
bin/jadd generate <myRoutingFile> <outputFile>, (*5)
It will parse your routes and consolidate the responses with tests recording., (*6)
Best place would be in
onSuccess hook of your CI., (*7)
For now, we support only install on PHP project through composer :, (*8)
composer require --dev rezzza/jadd:dev-master
- Symfony YAML (Don't support YAML +
@Route Annotation in Controller)