安装swagger包

  • 链接：swagger包

  • 安装：composer require zircote/swagger-php 版本：”zircote/swagger-php”: “^4.4”

    构建Controller和route

    ```php <?php

    namespace App\Http\Controllers\NoMiddle;

use App\Http\Controllers\Controller; use Illuminate\Http\Request; use Swagger\Annotations\Info; use Swagger\Annotations\OA;

/**

  • @OA\Info(title=”属于我自己的接口”, version=”0.1”, description=”债务模块的接口以及自己测试的接口”) */ class SwaggerController extends Controller { public function doc() { $swagger = \OpenApi\Generator::scan([
    1. app_path('Http/Controllers/NoMiddle'), // 第一个地址里面要有@OA\Info
    2. app_path('Http/Controllers/DebtSelf'), // 其他的控制器目录地址
    ]); return response()->json($swagger); } }

// swagger 文档 Route::get(‘/swagger/doc’, ‘SwaggerController@doc’);

  1. <a name="ENReT"></a>
  2. # 安装swagger-ui
  4. - 在public下执行`git clone [https://github.com/swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui)`会将前端代码添加进swagger-ui目录
  5. - git clone拷贝完之后呢，其实我们只需要 dist目录就行，其他的目录以及文件可以删掉
  6. - 将其中的dist中的index.html改为
  7. ```html
  8. <!-- HTML for static distribution bundle build -->
  9. <!DOCTYPE html>
  10. <html lang="en">
  11.   <head>
  12.     <meta charset="UTF-8">
  13.     <title>Swagger UI</title>
  14.     <link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
  15.     <link rel="stylesheet" type="text/css" href="index.css" />
  16.     <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
  17.     <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
  18.   </head>
  20.   <body>
  21.     <div id="swagger-ui"></div>
  22.     <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
  23.     <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
  24.     <script src="./swagger-initializer.js" charset="UTF-8"> </script>
  25.     <script>
  26.       window.onload = function() {
  27.         // Begin Swagger UI call region
  28.         const ui = SwaggerUIBundle({
  29.           // url: "https://petstore.swagger.io/v2/swagger.json",
  30.           url:  "/swagger/doc", //新的配置
  31.           dom_id: '#swagger-ui',
  32.           deepLinking: true,
  33.           presets: [
  34.             SwaggerUIBundle.presets.apis,
  35.             SwaggerUIStandalonePreset
  36.           ],
  37.           plugins: [
  38.             SwaggerUIBundle.plugins.DownloadUrl
  39.           ],
  40.           layout: "StandaloneLayout"
  41.         })
  42.         // End Swagger UI call region
  44.         window.ui = ui
  45.       }
  46.     </script>
  47.   </body>
  48. </html>
  • 就可以直接通过/swagger-ui/dist/index.html路径来访问到swagger文档了

创建新的控制器以及接口

  1. <?php
  3. namespace App\Http\Controllers\DebtSelf;
  5. use Illuminate\Http\Request;
  6. use App\Http\Controllers\Controller;
  7. use App\Services\ValidaParamService;
  9. /**
  10.  * @OA\Tag(
  11.  *     name="债务",
  12.  *     description="何日可以出坑",
  13.  * )
  14.  */
  15. class DebtIndexController extends Controller
  16. {
  17.     private $verifyParamService;
  19.     function __construct(
  20.         ValidaParamService $verifyParamService
  21.     ){
  22.         $this->verifyParamService = $verifyParamService;
  23.     }
  25.     /**
  26.      * @OA\Post(
  27.      *     path="/debtSelf/add",
  28.      *     tags={"债务"},
  29.      *     summary="添加",
  30.      *     @OA\Parameter(name="isFastLogin", in="query", @OA\Schema(type="boolean")),
  31.      *     @OA\Parameter(name="tel", in="query", @OA\Schema(type="string")),
  32.      *     @OA\Parameter(name="verification_code", in="query", @OA\Schema(type="string")),
  33.      *     @OA\Parameter(name="password", in="query", @OA\Schema(type="string")),
  34.      *     @OA\Response(response=200, description="  {err_code: int32, msg:string, data:[]}")
  35.      * )
  36.      */
  37.     public function add(Request $request)
  38.     {
  39.         try {
  40.             $data = [ "code" => 200, "data" => app_path('Http/Controllers/DebtSelf') ];
  42.             $rule = [];
  44.             $param = $this->verifyParamService
  45.                 ->init($rule, $request->all())
  46.                 ->filter()
  47.                 ->needRequired()
  48.                 ->param;
  50.             return response()->json($data);
  51.         } catch(\Exception $e) {
  53.             return errorLog($e);
  55.         }
  56.     }
  57. }

关于注解详细请看：https://github.com/zircote/swagger-php/blob/master/docs/Migrating-to-v3.md