這篇文章將為大家詳細講解有關(guān)在laravel中使用apidoc的示例,小編覺得挺實用的,因此分享給大家做個參考,希望大家閱讀完這篇文章后可以有所收獲。
第一步:使用:npm install apidoc -g
命令安裝apidoc。
第二步:在項目根目錄下新建apidoc.json
文件,文件內(nèi)容格式參考如下:
{ "name": "laravel5 API文檔", "version": "v1.0", "description": "本文檔提供laravel5 商品,訂單,收貨地址,等API文檔供嗨聊服務(wù)端開發(fā)人員作為參考,文檔使用RESTfull風(fēng)格,如有疑問請聯(lián)系開發(fā)者", "apidoc": { "title": "laravel5 API文檔", "url" : "http://http://www.learnlaravel5.com//api" }}
如圖:
第三步:使用apidoc -i myapp/ -o apidoc/ -t mytemplate/"
其中: -i 表示輸入,后面是文件夾路徑-o 表示輸出,后面是文件夾路徑默認會帶上-c,在當前路徑下尋找配置文件(apidoc.json),如果找不到則會在package.json中尋找 "apidoc": { } myapp/ 表示要生成api的源文檔所在目錄位置 mytemplete/ 表示要生成api到的目錄位置
如:我要將app/Http/Controllers/Api/
目錄下的文檔生成api文件到public/api
的命令如下:
apidoc -i app/Http/Controllers/Api/ -o public/api
如圖:
目錄結(jié)構(gòu)如圖:
關(guān)于“在laravel中使用apidoc的示例”這篇文章就分享到這里了,希望以上內(nèi)容可以對大家有一定的幫助,使各位可以學(xué)到更多知識,如果覺得文章不錯,請把它分享出去讓更多的人看到。