溫馨提示×

您好，登錄后才能下訂單哦！

密碼登錄×
登錄注冊(cè)×
其他方式登錄
點(diǎn)擊 登錄注冊(cè) 即表示同意《億速云用戶(hù)服務(wù)條款》

在laravel中使用apidoc的示例

發(fā)布時(shí)間：2021-01-29 10:17:12 來(lái)源：億速云 閱讀：337 作者：小新 欄目：編程語(yǔ)言

這篇文章將為大家詳細(xì)講解有關(guān)在laravel中使用apidoc的示例，小編覺(jué)得挺實(shí)用的，因此分享給大家做個(gè)參考，希望大家閱讀完這篇文章后可以有所收獲。

第一步：使用：npm install apidoc -g
命令安裝apidoc。
第二步：在項(xiàng)目根目錄下新建apidoc.json文件，文件內(nèi)容格式參考如下：

{
  "name": "laravel5 API文檔",
  "version": "v1.0",
  "description": "本文檔提供laravel5 商品，訂單，收貨地址，等API文檔供嗨聊服務(wù)端開(kāi)發(fā)人員作為參考，文檔使用RESTfull風(fēng)格，如有疑問(wèn)請(qǐng)聯(lián)系開(kāi)發(fā)者",
  "apidoc": {
    "title": "laravel5 API文檔",
    "url" : "http://http://www.learnlaravel5.com//api"
  }}

如圖：在laravel中使用apidoc的示例

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

其中：
-i 表示輸入，后面是文件夾路徑-o 表示輸出，后面是文件夾路徑默認(rèn)會(huì)帶上-c，在當(dāng)前路徑下尋找配置文件(apidoc.json)，如果找不到則會(huì)在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的示例

目錄結(jié)構(gòu)如圖：在laravel中使用apidoc的示例

關(guān)于“在laravel中使用apidoc的示例”這篇文章就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，使各位可以學(xué)到更多知識(shí)，如果覺(jué)得文章不錯(cuò)，請(qǐng)把它分享出去讓更多的人看到。

向AI問(wèn)一下細(xì)節(jié)

免責(zé)聲明：本站發(fā)布的內(nèi)容（圖片、視頻和文字）以原創(chuàng)、轉(zhuǎn)載和分享為主，文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱：is@yisu.com進(jìn)行舉報(bào)，并提供相關(guān)證據(jù)，一經(jīng)查實(shí)，將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI
助
手