This package is currently in early alpha. It is not recommended to use on a production enviroment.
Due to changes in Lumen 5.2, this package needs updated to remove dependency on rendering Laravel views.
An automatic api documentation generator for Laravel applications.
You can either add the package directly by firing this command
$ composer require rabblerouser/api-autodoc:*
-- or --
Add in the require key of composer.json file manually
"rabblerouser/api-autodoc": "*"
And Run the Composer update command
$ composer update
Add the following service providers to your bootstrap/app.php file.
$app->register(RabbleRouser\ApiAutoDoc\Providers\DocumentationServiceProvider::class);
$app->register('Irazasyed\Larasupport\Providers\ArtisanServiceProvider');Add the following service providers to your config/app.php file.
'providers' => [
// Other Service Providers
RabbleRouser\ApiAutoDoc\Providers\DocumentationServiceProvider::class,
'Irazasyed\Larasupport\Providers\ArtisanServiceProvider'
],If you want to override the default view templates, run the artisan publish command.
$ php artisan vendor:publish
This will create a vendor/api-autodoc/views/ directory in the resources directory of your Lumen/Laravel installation.
Api AutoDoc will load those templates instead of its defaults.
In your application's routes.php file, add a docCategory parameter to the route array.
$app->get('some_resource', [
'uses' => 'App\Http\Controllers\SomeResourceController@index',
'docCategory' => 'Some Resource'
]);You can see your autogenerated API documentation by going to the /docs page of your site.
http://api.mywebservice.com/docs
- add tests
- update to remove dependency on Laravel views