2017 © Pedro Peláez
 

library jadd

Jadd : Another Documentation Dumper

image

rezzza/jadd

Jadd : Another Documentation Dumper

  • Sunday, February 5, 2017
  • by tyx
  • Repository
  • 8 Watchers
  • 3 Stars
  • 7,902 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 3 Forks
  • 7 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

JADD Build Status

Jadd : Another Documentation Dumper, (*1)

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, (*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)

Install

For now, we support only install on PHP project through composer :, (*8)

composer require --dev rezzza/jadd:dev-master

Routing supported

  • Symfony YAML (Don't support YAML + @Route Annotation in Controller)

Output supported

The Versions

05/02 2017

dev-master

9999999-dev

Jadd : Another Documentation Dumper

  Sources   Download

MIT

The Requires

 

The Development Requires

by ReZzZa Team