使用 swagger 自动生成 api 文档
使用 swagger 自动生成 api 文档,有需要的朋友可以参考下。
一、下载 swagger-ui 直接上传服务器
二、下载 swagger-php 根据文档进行安装
三、php文件添加注释代码
/**
* @swg/resource (
* apiversion = "版本号",
* basepath = "api地址",
* resourcepath ="项目名称",
* @swg/api (
* path = "api文件名",
* description = "功能描述",
* @swg/operation (
* method="post", summary="操作描述", nickname = "显示名",
* @swg/parameter (name="参数名", description="参数说明", required = true, paramtype = "query", type="string"),
* @swg/responsemessage (code=200, message="返回说明")
* )
* )
*)
*/
四、使用swager-php 生成json地址
php ../composer/vendor/zircote/swagger-php/swagger.phar /apifolder -o /docfolder
五、修改swagger-ui 默认数据地址
六、done