首頁 > 後端開發 > php教程 > PHP使用 swagger 自动生成 API 文档

PHP使用 swagger 自动生成 API 文档

不言
發布: 2023-02-28 15:28:01
原創
8598 人瀏覽過

使用 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

相關標籤:
來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
作者最新文章
最新問題
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板