国产xxxx99真实实拍_久久不雅视频_高清韩国a级特黄毛片_嗯老师别我我受不了了小说

資訊專欄INFORMATION COLUMN

接口文檔生成工具—apidoc

warmcheng / 1985人閱讀

摘要：使用方法我們以的項目為例創(chuàng)建項目文檔項目描述項目文檔我們在文件夾下建立文件夾，用于書寫接口注釋說明例如新聞詳情新聞結(jié)果標(biāo)識結(jié)果說明結(jié)果數(shù)據(jù)成功調(diào)用生成命令以上命令的意思是讀取文件夾下的配置，輸出說明文檔到文件夾打開生成后的即可

apiDoc在您的源代碼中通過創(chuàng)建API注釋從而生成api說明文檔。
http://apidocjs.com/#param-ap...

使用方法

我們以express的項目為例

1 創(chuàng)建apidoc.json

{
  "name": "abc項目 api 文檔",
  "version": "1.0.0",
  "description": "項目描述",
  "title": "abc項目api文檔",
  "url" : "localhost:3000/api",
  "template": {
    "withCompare": true,
    "withGenerator": true
  }
}

2 我們在routes文件夾下建立api文件夾，用于書寫接口注釋說明,例如

/**
 * @api {get} /news/newsContent 新聞詳情
 * @apiVersion 1.0.0
 * @apiName newsContent
 * @apiGroup news
 * @apiParam {Number} id 新聞id
 * @apiSuccess {Number} code 結(jié)果標(biāo)識
 * @apiSuccess {String} message 結(jié)果說明
 * @apiSuccess {Object} data 結(jié)果數(shù)據(jù)
 * @apiSuccessExample Success-Response:
 *     HTTP/11 200 OK
 *     {
 *       "code": 1,
 *       "mess": "成功",
 *       "data": {}
 *     }
 */

3 調(diào)用生成命令

apidoc -i routes/ -o public/apidoc/

以上命令的意思是讀取routes文件夾下的api配置，輸出api說明文檔到public/apidoc/文件夾
打開生成后的index.html即可

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

轉(zhuǎn)載請注明本文地址：http://specialneedsforspecialkids.com/yun/89190.html

相關(guān)文章

  • Web API 文檔生成工具 apidoc

    摘要：實現(xiàn)接口文檔編寫工作，有很多種方式，例如通過文檔編寫，或者通過進(jìn)行維護(hù)。這里，筆者想分享另一個文檔生成工具。此外，可以支持多種語言，，，，，，。查詢簽收預(yù)警策略查詢簽收預(yù)警策略平臺類型商家名稱最后，我們在終端輸入命令進(jìn)行文檔生成。 原文地址：梁桂釗的博客 在服務(wù)端開發(fā)過程中，我們需要提供一份 API 接口文檔給 Web 端和移動端使用。實現(xiàn) API 接口文檔編寫工作，有很多種方式，例...

    sushi 評論0 收藏0

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

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

    zsirfs 評論0 收藏0

  • ApiDoc的使用

    摘要：說明是一個接口文檔，它的創(chuàng)建方式是基于你的源代碼的接口備注。我們只需要給接口寫好相應(yīng)的文檔，然后使用生成接口文檔工具生成文檔，便于管理和查看。配置方式安裝是啥自己問前端同學(xué)吧。。創(chuàng)建官方示例生成運行補充備注參考 說明 apiDoc creates a documentation from API annotations in your source code apiDoc是一個接口文檔...

    ityouknow 評論0 收藏0

  • php - Api 接口寫法規(guī)范和要求

    摘要：前言說明是一個文檔生成工具可以根據(jù)代碼注釋生成文檔從注釋生成靜態(tài)網(wǎng)頁文檔，不僅支持項目版本號，還支持版本號安裝系統(tǒng)需要安裝略安裝有些系統(tǒng)需要權(quán)限來安裝執(zhí)行生成這個文檔的生成規(guī)則是對于項目中我們使用封裝了一個函數(shù)生成文檔注意分組名不 前言 說明apidoc是一個API文檔生成工具, apidoc可以根據(jù)代碼注釋生成web api文檔, apidoc從注釋生成靜態(tài)html網(wǎng)頁文檔，不僅支持...

    k00baa 評論0 收藏0

發(fā)表評論

0條評論

最新活動
閱讀需要支付1元查看
<