This Laravel package provides an API Documentation generator based upon your Routes and Controller Method DocBlock comments.
Begin by installing this package through Composer. Edit your project's composer.json
file to require f2m2/apidocs
.
"require-dev": {
"f2m2/apidocs": "dev-master"
}
Next, update Composer from the Terminal:
composer update
Once the packaage has installed, the final step is to add the service provider. Open config/app.php
, and add a new item to the providers array.
'F2m2\Apidocs\ApidocsServiceProvider',
Run the artisan
command from the Terminal to see the new apidocs
command.
php artisan apidocs:generate
Create a copy of the API Docs Config by running this artisan
command:
php artisan vendor:publish
See installation: https://github.com/f2m2/apidocs/tree/1.0.0
Create a prefix for your routes with an API Version. i.e. 'api/v1
Route::group(['prefix' => 'api/v1'], function(){
// ...
});
########
Laravel 5.4 defaults to api prefix (Route::prefix('api')
).
If your routes/api.php looks like this...
Route::group(['prefix' => 'v1'], function(){
// ...
});
... then the route for the generate command would be api/v1
Otherwise it will be just api
Below is a docBlock example.
/**
* Display the specified resource.
* GET /user/{id}
*
* @param int $id The id of a User
* @return Response
*/
public function show($id)
{
// Display User
}
See LICENSE file.