thinkphp5结合swagger自动生成接口文档
整体介绍
swagger-php、swagger-ui、swagger-editor
-
swagger-ui:主要就是放到tp项目public目录下,配置yaml文件url后访问可以展示swagger的主页面
-
swagger-php:将有swagger规定注释的php文件打包生成一个yaml文件
-
swagger-editor:就是可以直接左侧在线写yaml文件,右侧生成页面展示,实时的
安装swagger-ui前端
可以使用git 获取swagger-ui,也可以去github上下载压缩包
如果是使用 git 克隆 swagger-ui,可以在当前项目的public目录下执行如下命令
git clone https://github.com/swagger-api/swagger-ui.git
也可以在其github官网上下载
https://github.com/swagger-api/swagger-ui.git
其实,这里面真正用到的是dist目录,所以如果下载过一次之后,再用时,只需要将 dist 目录拷贝到项目的 public 目录下,改名为swagger-ui即可。
安装swagger-php
在你的tp项目目录下执行composer命令:
composer require zircote/swagger-php
提示安装成功后会在tp项目的verdor中生成一个zircote的组件文件夹,说明已经安装插件成功了。最新的版本在bin目录下是一个openapi文件,生成yaml文件,这个对应@OA\啥啥啥的
使用composer命令安装其他版本,bin目录下面是一个swagger文件,生成json文件,可以让我们小白更容易读懂,这个json对应注释是@SWG\啥啥啥的
composer require "zircote/swagger-php:2.0.13"