https://github.com/ubirak/jadd
Jadd is Another Documentation Dumper
https://github.com/ubirak/jadd
automation documentation-dumper living-documentation php
Last synced: 12 months ago
JSON representation
Jadd is Another Documentation Dumper
- Host: GitHub
- URL: https://github.com/ubirak/jadd
- Owner: ubirak
- License: mit
- Created: 2016-08-12T14:36:41.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-02-05T17:59:33.000Z (over 9 years ago)
- Last Synced: 2024-04-27T19:05:35.934Z (about 2 years ago)
- Topics: automation, documentation-dumper, living-documentation, php
- Language: PHP
- Homepage:
- Size: 30.3 KB
- Stars: 3
- Watchers: 7
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JADD [](https://travis-ci.org/rezzza/jadd)
Jadd : Another Documentation Dumper
## Why ?
- 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
## How ?
2 steps are needed
### 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 ?
If you use [php-http](http://php-http.org), we provide a [middleware to collect the data](https://github.com/rezzza/jadd/blob/master/src/Infra/Http/CollectEndpointPlugin.php) during your tests. [Have a look on the test](https://github.com/rezzza/jadd/blob/master/features/collect_endpoint.feature#L41) to be sure how to use it.
### Consolidate routing file
Then just need to run the `bin/jadd generate `
It will parse your routes and consolidate the responses with tests recording.
Best place would be in `onSuccess` hook of your CI.
## Install
For now, we support only install on PHP project through composer :
```
composer require --dev rezzza/jadd:dev-master
```
## Routing supported
- Symfony YAML (Don't support YAML + `@Route` Annotation in Controller)
## Output supported
- [APIBlueprint](https://apiblueprint.org/)