laravel 集成 swagger插件

原文链接：https://medium.com/@mahbubkabir/discovering-swagger-in-laravel-rest-apis-cb0271c8f2

1.composer 安装插件

composer require darkaonline/l5-swagger

2.生成配置文件

php artisan l5-swagger:publish

3.忽略文件

./public/vendor/l5-swagger
./resources/views/vendor/l5-swagger

4.生成可读取的json文件

php artisan l5-swagger:generate

php artisan l5-swagger:publish

设置步骤2中生成的配置文件 自动生成json文件
L5_SWAGGER_GENERATE_ALWAYS=true

5.在基类控制器添加如下字符串

    /**
     * @SWG\Swagger(
     *   basePath="/api",
     *   @SWG\Info(
     *     title="Customer rate calculator API",
     *     version="1.0.0"
     *   )
     * )
     */

5.在子类控制器 添加如下代码，需要根据自己需要的参数配置

/**
 * @SWG\Get(
 *   path="/customer/{customerId}/rate",
 *   summary="List customer rates",
 *   operationId="getCustomerRates",
 *   @SWG\Parameter(
 *     name="customerId",
 *     in="path",
 *     description="Target customer.",
 *     required=true,
 *     type="integer"
 *   ),
 *   @SWG\Parameter(
 *     name="filter",
 *     in="query",
 *     description="Filter results based on query string value.",
 *     required=false,
 *     enum={"active", "expired", "scheduled"},
 *     type="string"
 *   ),
 *   @SWG\Response(response=200, description="successful operation"),
 *   @SWG\Response(response=406, description="not acceptable"),
 *   @SWG\Response(response=500, description="internal server error")
 * )
 *
 */

　　6.

添加header 信息
* @SWG\Parameter(
     *     name="debug",
     *     in="header",
     *     required=false,
     *     type="string"
     *   ),

添加json 字符串
* @SWG\Parameter(
     *     name="debug",
     *     in="body",
     *     required=false,
     *     type="string"
     *   ),