PHP使用 swagger 自動產生 API 文檔

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

