laravel中使用apidoc

apidoc官方文檔:http://apidocjs.com/#params

第一步:使用:npm install apidoc -g 
命令安裝apidoc。 
第二步:在項目根目錄下新建apidoc.json文件,文件內容格式參考如下:

{
  "name": "laravel5 API文檔",
  "version": "v1.0",
  "description": "本文檔提供laravel5 商品,訂單,收貨地址,等API文檔供嗨聊服務端開發人員作爲參考,文檔使用RESTfull風格,如有疑問請聯繫開發者",
  "apidoc": {
    "title": "laravel5 API文檔",
    "url" : "http://http://www.learnlaravel5.com//api"
  }}123456789123456789

如圖:這裏寫圖片描述

第三步:使用apidoc -i myapp/ -o apidoc/ -t mytemplate/"

其中:
-i 表示輸入,後面是文件夾路徑-o 表示輸出,後面是文件夾路徑默認會帶上-c,在當前路徑下尋找配置文件(apidoc.json),如果找不到則會在package.json中尋找 "apidoc": { }
myapp/ 表示要生成api的源文檔所在目錄位置
mytemplete/ 表示要生成api到的目錄位置12345671234567

如:我要將app/Http/Controllers/Api/目錄下的文檔生成api文件到public/api的命令如下:

apidoc -i app/Http/Controllers/Api/ -o public/api11

如圖:這裏寫圖片描述

目錄結構如圖:這裏寫圖片描述


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章