1. 程式人生 > >開發接口文檔--本接口文檔是讀取控制器方法上的註釋自動生成的

開發接口文檔--本接口文檔是讀取控制器方法上的註釋自動生成的

config url 格式 格式化輸出 方便 api 修改 ima 抽取

本文檔是參考網上的然後根據公司需要對代碼進行了抽取和優化(主要是加了標題欄和對輸出進行了格式化輸出,更換呢了頁面渲染方式(改為直接使用php進行渲染,原來的是使用了模板引擎),可讀性較好),配置簡單,讀取方便,和項目耦合性較小,只需要將api_view這個文件夾放到和項目同級就可以使用,接口文檔只有100多k大小

1.配置控制器

技術分享圖片

按照上圖格式寫接口方法註釋(主是在控制器上面和方法上)

2.將接口文檔放置在和項目同級

技術分享圖片

註:上面3個事項目,最下面的是接口文檔

3.配置接口文檔配置文件

api_view\tool\config.php

技術分享圖片

上述配置文件的配置應該配置自己本地真實的配置,url為項目控制器所在的文件,這裏有3個項目,其中javaApi控制器是放在了app項目下,所以會對這個文件做單獨處理,就是下面的變動項

註:domain域名前不要加http://

4.主文件變動項

api_view\apiview.php

技術分享圖片

註:這個變動項,需要根據項目實際情況進行配置修改,其他文件區域不用修改

5.訪問接口文檔最終效果

技術分享圖片

下面是開發的接口調試文檔,方便易用,都是讀取的接口方法上的註釋自動生成

技術分享圖片

技術分享圖片

開發接口文檔--本接口文檔是讀取控制器方法上的註釋自動生成的