codeigniter整合Swagger自動化生成RESTFUL文件
阿新 • • 發佈：2019-01-30
最近用CI寫一個移動APP的伺服器端RESTFUL介面。在開發過程中與前端開發人員溝通介面至關重要。原來我們一直使用WORD文件，上傳到QQ群供前端開發下載。雖然工作進行沒什麼大問題，但是每次寫完程式碼都的寫WORD文件再傳到QQ群的方式我還是感到很低效。
因此我就研究了原來用beego(golang寫的WEB框架)時看到的Swagger工具，看看能不能整合到CI中，GOOGLE了一下，發現了一個codeigniter-swagger的工具。工具使用很簡單。把swagger包拷到根目錄下就可以使用了。我分析swagger的原理是將程式碼裡符合swagger規範的註釋抽取出來翻譯為文件。我按照範例寫了註釋，然後執行了php swagger.phar /home/wwwroot/ci/application/controller（註釋目錄）
-o /home/wwwroot/ci/docs/json（線上文件目錄） 命令。線上文件就生成了，不過文件的程式碼註釋會很多。採用這個工具不僅和前端溝通變得更簡單，而且對養成後端開發人員良好的程式碼和註釋規範也起到了很好的督促作用。
codeigniter-swagger的GITHUB地址：https://github.com/panxp/codeigniter-swagger
swagger的官方網址：http://swagger.io/