Download the PHP package f2m2/apidocs without Composer
On this page you can find all versions of the php package f2m2/apidocs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package apidocs
Short Description Laravel API Documentation Generator
License MIT
Homepage https://github.com/f2m2/apidocs
Informations about the package apidocs
Laravel API Docs Generator
This Laravel package provides an API Documentation generator based upon your Routes and Controller Method DocBlock comments.
Installation
Laravel 5.0
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
Laravel 4.2
See installation: https://github.com/f2m2/apidocs/tree/1.0.0
Notes
Route Prefix
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
DocBlock Example
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
}
License
See LICENSE file.
All versions of apidocs with dependencies
php Version >=5.4.0
phpdocumentor/reflection-docblock Version 2.0.*@dev