Laravel Swagger 生成 API 文件

1. 安裝 l5-swagger 包

https://github.com/DarkaOnLine/L5-Swagger

2. PHPStorm 安裝 php annotations 外掛

增加一條別名資料, 下圖紅線畫出來的. 這樣就可以有 swagger 的註釋提示了.

3. 如何編寫 註釋 進而生成 文件

3.1 學習資源

1. swagger-php guide
2. swagger-php 裡面有例子,但是我發現好像不是很全
3. Swagger Editor
4. swagger 文件

加油好好看!

4. 當前遇到的問題

1. @AO\Header 在 swagger ui 中不顯示(我用的是 openApi 3.0).

5. 總結

就目前我的體驗, 個人感覺這個東西上手稍微有點難, 而且在每個方法前面寫 Swagger 的註釋很麻煩, 編寫文件註釋比開發的時間還要長.倒不如直接編寫 swagger 讀取的 json/ymal 檔案.

本作品採用《CC 協議》，轉載必須註明作者和本文連結