關於THINKPHP5 集成 Swagger (一次成功)

後端安裝

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="獲取成功"
     *     )
     * )
     */