app後端開發二：API介面文檔工具

標籤：app介面文檔   api文檔   api介面文檔   app介面   api文檔工具   

悲傷的曆史

在進行app後端開發過程中，後端會提供出來很多的api介面供前端開發使用，為了讓前端開發人員順利使用，我們會寫好一份文檔，告訴他們這個介面你該用 GET 還是 POST 來訪問，同時訪問的時候該給我傳遞一些什麼參數，以及正確的時候我會返回什麼給你，已經返回的資料樣式以及欄位解釋等等這些事情，我們都需要在文檔中寫好寫清楚。

在 app後端開發一：基於swagger-ui構建api介面文檔工具 這篇部落格中，我寫了 swagger-ui 的好處以及優勢。但是在使用過程中，發現不夠給力。我想要達到的是代碼寫完，注釋寫完API介面文檔就出來了。不用再費時費力的單獨去維護它。因此今天決定告訴大家如果利用Laravel5來自動產生API介面文檔。

PS：如果你對 Laravel5 還不夠瞭解，可以點擊這裡 查看。

使用情境

這是我基於 Laravel5 開發的一個API文檔自動產生外掛程式。它前端利用的還是Swagger-UI(使用的還是我自己改造的中文版)，後端使用的是Swagger-PHP。通過composer安裝該外掛程式後，只要你寫的Model與Controller按照規定寫好注釋，你的API文檔就會在訪問的時候自動掃描這些注釋，來即時產生API文檔介面。

效果：

這個展現了每個模組提供的操作。

點擊測試按鈕後，可以直接進行操作，這裡前端的介紹跟我寫的第一篇文檔是一直的。

這裡主要增加的在於後端部分自動產生，前端沒有什麼變化。

擷取這個外掛程式

具體怎麼安裝繼承到項目中，請看這裡
項目地址： GitHub項目地址
備忘：該項目只能用於Laravel5，並且只能使用composer進行安裝。

如果大家覺得有協助，或者能夠提供協助一起完善這個項目的，歡迎 Star 與 Pull requests！

著作權聲明：本文為博主原創文章，未經博主允許不得轉載。

app後端開發二：API介面文檔工具