rygilles/laravel-apidoc-generator

This package is abandoned and no longer maintained. No replacement package was suggested.

Laravel API documentation generator, based on mpociot lib with Passport integration and user UUID

v0.1.1 2017-09-14 13:07 UTC

Requires

• mpociot/laravel-apidoc-generator: 2.0

MIT

• Ryan Gilles

README

Laravel API documentation generator, based on mpociot's lib : https://github.com/mpociot/laravel-apidoc-generator.

(Work in progress... personal features on test).

Added Features

• Fix for models tranformers (reported here : mpociot/laravel-apidoc-generator#153)
• Extra logs
• Removed (int) explicit variable casting for UUID support in setUserToBeImpersonated method.
• Dingo Generator :
  • Custom models features support : Try to add extra model description for the routes (Pagination GET parameters settings page / limit values with models methods getPerPageMin, getPerPageMax and getPerPage).
  • bindedUri value in routes descriptions for example requests.
  • Faker values randomized for each routes (not only per resource).
  • Routes calling extra headers 'Content-Type' => 'application/json' and 'Accept' => 'application/json'.
  • Passport guard "api" user support (When using actAsUserId).
  • uuid rule support for fake values.
  • strength (password) rule support for fake values.
  • md5 rule support for fake values.

PhpDoc

Use @ApiDocsNoCall tag on your Api controllers methods to ignore calling the route when generating the documentation (Usefull for update and destroy methods)