autaut03/laravel-api-docs-generator

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

Generate beautiful API documentation from your Laravel application

dev-master 2018-08-24 18:59 UTC

Requires

• php: >=7.1.3
• laravel/framework: 5.6.*
• mpociot/reflection-docblock: ^1.0
• ramsey/uuid: ^3.0

Requires (Dev)

• mockery/mockery: ^0.9.5
• orchestra/testbench: ~3.0
• phpunit/phpunit: ~7.0

MIT

• Oleksandr Prypkhan

• documentation
• api
• laravel

README

BETA VERSION

NO HTML GENERATION AVAILABLE YET.

Automatically generate your API documentation from your existing Laravel routes. No example available for now.

Installation

Require this package with composer using the following command:

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

Using Laravel < 5.5? Go to your config/app.php and add the service provider:

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:

$ php artisan vendor:publish

After that views and assets will appear inside resources/vendor/api-docs directory and will be used instead of default.

Usage

To generate your API documentation, use the api-docs:generate artisan command.

$ 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

How does it work?

This package uses these resources to generate the API documentation:

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