后端安装
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="获取成功"
* )
* )
*/