教你在laravel使用apidoc！

下面由Laravel教學專欄為大家介紹在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"
  }}

如圖：

第三個步驟：使用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

如圖：

目錄結構如圖：

以上是教你在laravel使用apidoc！的詳細內容。更多資訊請關注PHP中文網其他相關文章！