johnylemon/explainer-laravel

API Explainer for laravel Framework

v1.0.1 2019-05-17 23:52 UTC

Requires

• johnylemon/explainer: ^1.0

MIT

• Piotr Krzempek

• rest
• api
• swagger

README

Explainer for Laravel

A simple Laravel api documentation generator

Core package: https://github.com/johnylemon/explainer

Features

This tool makes possible to explain every app route by using simple explain method via clean document accessible under configured route address.

How to use

Simply call explain method on your routes:

Route::get('/', 'IndexController@index')->explain(\App\Explains\IndexRouteExplain::class);

Examples

Explain file generation

To generate route explain file with name IndexRouteExplain in app/Explains directory simply type:

php artisan explain:route IndexRouteExplain

Explain example generation

To generate route explain example file with name ValidationExample in app/Explains/Examples directory simply type:

php artisan explain:example ValidationExample

generate documentation

Simply type

php artisan explain

and... enjoy!