Laravel API Docs 安装

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

会弹出一个输入路径的就输入：api/v1  因为我们生成是v1的 

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/v1Otherwise 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
}

最后访问路劲：http://127.0.0.1/api/v1/docs 
接口有更改要更新文档：

php artisan apidocs:generate 
才会生效

该作品来源：https://packalyst.com/packages/package/f2m2/apidocs