autaut03/laravel-api-docs-generator

Generate beautiful API documentation from your Laravel application

[WIP] Laravel API documentation generator

, _(*1)

BETA VERSION

NO HTML GENERATION AVAILABLE YET., _(*2)

Automatically generate your API documentation from your existing Laravel routes. No example available for now., _(*3)

Installation

Require this package with composer using the following command:, _(*4)

$ composer require autaut03/laravel-api-docs-generator

Using Laravel < 5.5? Go to your config/app.php and add the service provider:, _(*5)

AlexWells\ApiDocsGenerator\PackageServiceProvider::class,

Publish vendor

If you want to modify HTML template or make some changes to the assets (img, css, js) then publish vendor files:, _(*6)

$ php artisan vendor:publish

After that views and assets will appear inside resources/vendor/api-docs directory and will be used instead of default., _(*7)

Usage

To generate your API documentation, use the api-docs:generate artisan command., _(*8)

$ php artisan api-docs:generate -m="api/v2/*" -m="non-api/another" -m="manual/{p}"

Use -h flag to get a list of available options, _(*9)

How does it work?

This package uses these resources to generate the API documentation:, _(*10)

TODO: use test cases & test fixtures as examples for now.