Thinkphp集成Swagger-PHP

网址：https://www.kancloud.cn/chengguang/swagger-php

一、Composer安装

本小册针对swagger-php2.0

composer require zircote/swagger-php:2.0.*

安装完成后，我们就可以编写注释了生成json文件了。

在控制器index中填入以下内容生成swagger.json

use Swagger\Annotations as SWG;  
class Index  
{  
     public function index()  
     {  
        $swagger=\Swagger\scan(__DIR__);  
        $res=$swagger->saveAs('./swagger.json');  
     }  
 }

Swagger-ui配置

 

官网地址：https://swagger.io/tools/swagger-ui/

找到swagger-ui下的dist/index.html

window.onload = function() {
  // Begin Swagger UI call region
  const ui = SwaggerUIBundle({
    //url:"http://www.tp.com.cn/swagger.json", //单文档地址
      urls:[{url:"http://www.tp.com.cn/swagger.json",name:"前端文档"},{url:"http://www.tp.com.cn/swagger-1.json",name:"后端文档"}], //开启Topbar插件支持多个文档
    dom_id: '#swagger-ui',
    deepLinking: false,
     validatorUrl: null, //关闭验证规则
     
    presets: [
      SwaggerUIBundle.presets.apis,
      SwaggerUIStandalonePreset
    ],
    plugins: [
      SwaggerUIBundle.plugins.DownloadUrl
    ],
    layout: "StandaloneLayout"
  })

/* @SWG\Post(
*     path="/index/register/index",
*     tags={"用户相关"},
*     summary="用户注册",
*     security={{"apikey"={}}},
*     consumes={"application/json"},
*     produces={"application/json"},
*     description="用户请求逻辑，记住用户请求一定要带token",
* ）
*/