亚洲中字慕日产2020,大陆极品少妇内射AAAAAA,无码av大香线蕉伊人久久,久久精品国产亚洲av麻豆网站

資訊專(zhuān)欄INFORMATION COLUMN

使用apidoc文檔神器，快速生成api文檔

boredream / 675人閱讀

摘要：寫(xiě)完接口，就需要編寫(xiě)文檔了，如果一個(gè)個(gè)手寫(xiě)的話(huà)就很麻煩，就得使用只需要通過(guò)寫(xiě)注釋?zhuān)涂梢钥焖偕晌臋n了。組將用于生成的輸出中的主導(dǎo)航。輸出文檔到文件夾，沒(méi)有回自動(dòng)創(chuàng)建。執(zhí)行訪(fǎng)問(wèn)就可以看到生成好的文檔了。

寫(xiě)完api接口，就需要編寫(xiě)api文檔了，如果一個(gè)個(gè)手寫(xiě)的話(huà)就很麻煩，就得使用apidoc只需要通過(guò)寫(xiě)注釋?zhuān)涂梢钥焖偕晌臋n了。

安裝

第一步先安裝全局模塊apidoc。

npm install apidoc -g
修改接口的注釋

找到novel-api項(xiàng)目routes下面的index.js文件，注釋修改成如下

/**
 * @api {get} /index 請(qǐng)求首頁(yè)數(shù)據(jù)
 * @apiVersion 1.0.0
 * @apiName 獲取首頁(yè)數(shù)據(jù)
 * @apiGroup index
 *
 *
 * @apiSuccess {Number} flag 是否獲取到數(shù)據(jù) 1成功 0失敗
 * @apiSuccess {Array} books 返回書(shū)籍內(nèi)容
 * @apiSuccess {String} msg  返回信息
 *
 * @apiSuccessExample {json} Success-Response:
 *     HTTP/1.1 200 OK
 *    {
 *      "flag": 1,
 *      "books": [
 *          {
 *             "_id": "5816b415b06d1d32157790b1",
 *            "title": "圣墟",
 *            "author": "辰東",
 *            "shortIntro": "在破敗中崛起，在寂滅中復(fù)蘇。滄海成塵，雷電枯竭，那一縷幽霧又一次臨近大地，世間的枷鎖被打開(kāi)了，一個(gè)全新的世界就此揭開(kāi)神秘的一角……",
 *            "cover": "http://statics.zhuishushenqi.com/agent/http%3A%2F%2Fimg.1391.com%2Fapi%2Fv1%2Fbookcenter%2Fcover%2F1%2F1228859%2F1228859_fac7917a960547eb953edf0b740cef3a.jpg%2F",
 *            "site": "zhuishuvip",
 *            "majorCate": "玄幻",
 *            "minorCate": "東方玄幻",
 *            "allowMonthly": false,
 *            "banned": 0,
 *            "latelyFollower": 283375,
 *            "retentionRatio": "73.42"
 *          }
 *      ],
 *      "msg": "OK"
 *    }
 *
 *
 * @apiErrorExample Error-Response:
 *     HTTP/1.1 404 Not Found
 *     { "flag": 0, "msg": "rankingId有問(wèn)題" }
 */

@api {method} path [title]
@api 如果沒(méi)有@api apidoc會(huì)忽略這段注釋
method 請(qǐng)求的方法
path 路徑
title 標(biāo)題

@apiVersion version
設(shè)置文檔塊的版本。
version 版本號(hào)

@apiName name
定義方法文檔塊的名稱(chēng)。名稱(chēng)將用于生成的輸出中的子導(dǎo)航。
name 方法的名稱(chēng)

@apiGroup name
定義方法文檔塊屬于哪個(gè)組。組將用于生成的輸出中的主導(dǎo)航。
name 組的名稱(chēng)。也用作導(dǎo)航標(biāo)題。

@apiSuccess [(group)] [{type}] field [description]
成功返回參數(shù)。
(group) 可選 所有參數(shù)將按這個(gè)名稱(chēng)分組。沒(méi)有組，默認(rèn)Success 200設(shè)置。
{type} 可選 返回類(lèi)型
field 返回標(biāo)識(shí)符
description 描述

@apiParamExample [{type}] [title]

               example

參數(shù)請(qǐng)求示例。
{type} 可選 響應(yīng)格式
title 示例的簡(jiǎn)稱(chēng)
example 詳細(xì)的例子

@apiErrorExample [{type}] [title]

             example

錯(cuò)誤返回消息的示例，輸出為預(yù)格式化代碼。
{type} 可選 響應(yīng)格式
title 示例的簡(jiǎn)稱(chēng)
example 詳細(xì)的例子

配置npm run doc

打開(kāi)package.json文件增加doc命令配置

"doc": "apidoc -i routes/ -o public/"

routes/ 要輸出API文檔的文件夾。
public/ 輸出文檔到public文件夾，沒(méi)有回自動(dòng)創(chuàng)建。
執(zhí)行 npm run doc
訪(fǎng)問(wèn) http://localhost:3000/ 就可以看到生成好的API文檔了。

線(xiàn)上生成的文檔地址

https://api.langpz.com/

我的博客和github，喜歡就去點(diǎn)點(diǎn)星吧，謝謝。

https://github.com/lanpangzhi

http://blog.langpz.com

參考

https://github.com/apidoc/apidoc

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://www.ezyhdfw.cn/yun/103524.html

相關(guān)文章

  • 開(kāi)源的api文檔管理系統(tǒng)

    摘要：國(guó)外的話(huà)國(guó)內(nèi)的國(guó)內(nèi)開(kāi)源的非常好用的一款文檔管理系統(tǒng)，安裝也非常方便，只需將源代碼放到項(xiàng)目目錄下自動(dòng)安裝運(yùn)行即可，不要要注意版本必須大于界面簡(jiǎn)潔功能強(qiáng)大的阿里的接口管理工具，開(kāi)源免費(fèi)，接口自動(dòng)化，數(shù)據(jù)自動(dòng)生成，自動(dòng)化測(cè)試，企業(yè)級(jí)管理。 在項(xiàng)目中，需要協(xié)同開(kāi)發(fā)，所以會(huì)寫(xiě)許多API文檔給其他同事，以前都是寫(xiě)一個(gè)簡(jiǎn)單的TXT文本或Word文檔，口口相傳，這種方式比較老土了，所以，需要有個(gè)api...

    zsirfs 評(píng)論0 收藏0

  • 利用apidoc維護(hù)api接口文檔

    摘要：什么是是一個(gè)輕量級(jí)的在線(xiàn)接口文檔生成系統(tǒng)，支持多種主流語(yǔ)言，包括和等。使用者按照要求書(shū)寫(xiě)相關(guān)注釋?zhuān)涂梢陨煽勺x性好界面美觀的在線(xiàn)接口文檔。雙擊文件夾下的，就能看到文檔了。 什么是apidoc apidoc是一個(gè)輕量級(jí)的在線(xiàn)REST接口文檔生成系統(tǒng)，支持多種主流語(yǔ)言，包括Java、C、C#、PHP和Javascript等。使用者按照要求書(shū)寫(xiě)相關(guān)注釋?zhuān)涂梢陨煽勺x性好、界面美觀的在線(xiàn)接...

    hiyayiji 評(píng)論0 收藏0

  • 利用apidoc維護(hù)api接口文檔

    摘要：什么是是一個(gè)輕量級(jí)的在線(xiàn)接口文檔生成系統(tǒng)，支持多種主流語(yǔ)言，包括和等。使用者按照要求書(shū)寫(xiě)相關(guān)注釋?zhuān)涂梢陨煽勺x性好界面美觀的在線(xiàn)接口文檔。雙擊文件夾下的，就能看到文檔了。 什么是apidoc apidoc是一個(gè)輕量級(jí)的在線(xiàn)REST接口文檔生成系統(tǒng)，支持多種主流語(yǔ)言，包括Java、C、C#、PHP和Javascript等。使用者按照要求書(shū)寫(xiě)相關(guān)注釋?zhuān)涂梢陨煽勺x性好、界面美觀的在線(xiàn)接...

    biaoxiaoduan 評(píng)論0 收藏0

  • 利用apidoc維護(hù)api接口文檔

    摘要：什么是是一個(gè)輕量級(jí)的在線(xiàn)接口文檔生成系統(tǒng)，支持多種主流語(yǔ)言，包括和等。使用者按照要求書(shū)寫(xiě)相關(guān)注釋?zhuān)涂梢陨煽勺x性好界面美觀的在線(xiàn)接口文檔。雙擊文件夾下的，就能看到文檔了。 什么是apidoc apidoc是一個(gè)輕量級(jí)的在線(xiàn)REST接口文檔生成系統(tǒng)，支持多種主流語(yǔ)言，包括Java、C、C#、PHP和Javascript等。使用者按照要求書(shū)寫(xiě)相關(guān)注釋?zhuān)涂梢陨煽勺x性好、界面美觀的在線(xiàn)接...

    shaonbean 評(píng)論0 收藏0

發(fā)表評(píng)論

0條評(píng)論

boredream

男|高級(jí)講師

TA的文章

閱讀更多
最新活動(dòng)
閱讀需要支付1元查看
<