关于THINKPHP5 集成 Swagger (一次成功)

后端安装

1.找到你项目中ThinkPHP文件里的composer.json文件,在require里面添加 “zircote/swagger-php”: “*” 进行安装,如下:
在这里插入图片描述
2.查看thinkphp下vendor有一个zircote文件夹表示安装成功
在这里插入图片描述
3.最后右键你的项目运行终端执行:

php E:\你的项目全路径\thinkphp\vendor\zircote\swagger-php\bin\openapi   E:\.....\controller\Index.php(你要生成文档的控制器全路径) -o E:\fuda\www.fudaai.com\web\thinkphp\swagger-docs你要生成json的位置

执行后thinkphp下多了一个swagger-docs 表示成功

前端安装

1.下载swagger-ui.git
git clone https://github.com/swagger-api/swagger-ui.git

2.下载好的文件找到dist目录,复制粘贴到自己的项目中,改名为swagger-ui,打开index.html把其中的那一串url改成自己生成的swagger-docs路径, 比如我的 url: “…/…/thinkphp/swagger-docs”,如下:
在这里插入图片描述

最后访问路径

http://localhost:86/public/swagger-ui/index.html 成功

在这里插入图片描述

自定义模板:

class类上添加


/**
 * @OA\Info(title="名字", version="0.1")
 */

方法上添加:

 /**
     * @OA\GET(
     *     tags={"显示-前台"},
     *     path="/index",
     *     summary="首页",
     *     description="显示页面",
     *     @OA\Response(
     *      response="200",
     *      description="获取成功"
     *     )
     * )
     */
    
  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 4
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值