利用apidoc維護api接口文檔

hiyayiji 發布于2019-06-28 13:50 / 2416人閱讀

摘要：什么是是一個輕量級的在線接口文檔生成系統，支持多種主流語言，包括和等。使用者按照要求書寫相關注釋，就可以生成可讀性好界面美觀的在線接口文檔。雙擊文件夾下的，就能看到文檔了。

什么是apidoc

apidoc是一個輕量級的在線REST接口文檔生成系統，支持多種主流語言，包括Java、C、C#、PHP和Javascript等。使用者按照要求書寫相關注釋，就可以生成可讀性好、界面美觀的在線接口文檔。

這里了解更多

快速開始

安裝依賴

安裝nodejs https://nodejs.org/官網下載.msi文件；
測試是否安裝成功 npm -v

npm的安裝。由于新版的NodeJS已經集成了npm，所以之前npm也一并安裝好了。同樣可以使用cmd命令行輸入"npm -v"來測試是否成功安裝。如下圖，出現版本提示便OK了。

安裝apidoc

利用npm進行安裝

npm install apidoc -g

安裝速度和網速有關，最多1到2分鐘，

apidoc -v  可以查看版本信息

安裝好后在

C:UsersadminAppDataRoaming
pm
ode_modulesapidoc

能夠看到如下文件

apidoc配置

打開example文件夾apidoc.json為配置文件,修改參數為自己的項目信息。

{
  "name": "apidoc-example",
  "version": "0.3.0",
  "description": "apidoc example project",
  "title": "Custom apiDoc browser title",
  "url" : "https://api.github.com/v1",
  "sampleUrl": "https://api.github.com/v1",
  "header": {
    "title": "My own header title",
    "filename": "header.md"
  },
  "footer": {
    "title": "My own footer title",
    "filename": "footer.md"
  },
  "template": {
      "withCompare": true,
      "withGenerator": true
  }
}

將 apidoc.json 拷貝到需要生成文檔的目錄下

然后按照文檔說明做代碼注釋

/**
 * @api {get} /sguoshan_api/Logon 獲取用戶信息
 * @apiVersion 1.0.0
 * @apiName  Logon
 * @apiGroup User
 * @apiPermission 所有已注冊用戶
 * @apiPrivate
 * @apiDescription 與0.9.0相比安全性提高
 *
 * @apiParam {String} username 用戶名稱/郵箱/會員號
 * @apiParam {Number} password 用戶密碼
 * @apiExample 使用示例:
 * http://api.guoshanchina.com/sguoshan_api/Logon?username=911117&password=123456
 *
 * @apiSuccess {Number}   id            The Users-ID.
 * @apiSuccess {Date}     registered    Registration Date.
 * @apiSuccess {Date}     name          Fullname of the User.
 * @apiSuccess {String[]} nicknames     List of Users nicknames (Array of Strings).
 * @apiSuccess {Object}   profile       Profile data (example for an Object)
 * @apiSuccess {Number}   profile.age   Users age.
 * @apiSuccess {String}   profile.image Avatar-Image.
 * @apiSuccess {Object[]} options       List of Users options (Array of Objects).
 * @apiSuccess {String}   options.name  Option Name.
 * @apiSuccess {String}   options.value Option Value.
 *
 * @apiSuccessExample 成功 return ():
{
"msg": "獲取成功",
"status":"200",
"data":{
    "id":"123",
    "name":"shmily"
    }
}
 * @apiError NoAccessRight     只用登陸成功才能訪問.
 * @apiError UserNotFound   用戶 id 錯誤.
 * @apiErrorExample 失敗 return ():
 *     HTTP/1.1 401 Not Authenticated
 *     {
 *       "msg": "沒有權限","status":"401"
 *     }
 */
function getUser() { return; }

在命令行中

切換到項目apidoc.json的上一級（api目錄）
d:
cd www/shop/Web
apidoc -i api/ -o apidoc/

運行后在api的同級目錄能夠看到生成了apidoc的文件夾。雙擊文件夾下的index.html，就能看到文檔了。

云服務器 GPU云服務器 api接口文檔 api短信接口文檔快遞api接口文檔 api接口文檔工具

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/25908.html

利用apidoc維護api接口文檔

摘要：什么是是一個輕量級的在線接口文檔生成系統，支持多種主流語言，包括和等。使用者按照要求書寫相關注釋，就可以生成可讀性好界面美觀的在線接口文檔。雙擊文件夾下的，就能看到文檔了。什么是apidoc apidoc是一個輕量級的在線REST接口文檔生成系統，支持多種主流語言，包括Java、C、C#、PHP和Javascript等。使用者按照要求書寫相關注釋，就可以生成可讀性好、界面美觀的在線接...

biaoxiaoduan 2019-08-21 16:41 評論0 收藏0
利用apidoc維護api接口文檔

摘要：什么是是一個輕量級的在線接口文檔生成系統，支持多種主流語言，包括和等。使用者按照要求書寫相關注釋，就可以生成可讀性好界面美觀的在線接口文檔。雙擊文件夾下的，就能看到文檔了。什么是apidoc apidoc是一個輕量級的在線REST接口文檔生成系統，支持多種主流語言，包括Java、C、C#、PHP和Javascript等。使用者按照要求書寫相關注釋，就可以生成可讀性好、界面美觀的在線接...

shaonbean 2019-07-30 14:42 評論0 收藏0
Web API 文檔生成工具 apidoc

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

sushi 2019-08-15 13:47 評論0 收藏0
[原] Python 開發者面向文檔編程的正確姿勢

摘要：用注釋寫單元測試單元測試是代碼開發環節必不可少的一環，對于定位和代碼質量而言是非常重要的。現在最廣為人知的單元測試框架就是，它借鑒了中成熟的單元測試框架的。概述 showImg(https://segmentfault.com/img/bVD66s?w=550&h=550); 秦人不暇自哀,而后人哀之;后人哀之而不鑒之,亦使后人而復哀后人也! --論面向文檔編程的重要性如果想看見識...

Y3G 2019-07-25 10:51 評論0 收藏0