ApiDoc的使用

ityouknow 發(fā)布于2019-06-28 18:39 / 2313人閱讀

摘要：說(shuō)明是一個(gè)接口文檔，它的創(chuàng)建方式是基于你的源代碼的接口備注。我們只需要給接口寫好相應(yīng)的文檔，然后使用生成接口文檔工具生成文檔，便于管理和查看。配置方式安裝是啥自己?jiǎn)柷岸送瑢W(xué)吧。。創(chuàng)建官方示例生成運(yùn)行補(bǔ)充備注參考

說(shuō)明

apiDoc creates a documentation from API annotations in your source code

apiDoc是一個(gè)接口文檔，它的創(chuàng)建方式是基于你的源代碼的接口備注。我們只需要給接口寫好相應(yīng)的文檔，然后使用apiDoc生成接口文檔工具生成文檔，便于管理和查看。

配置方式

1.安裝apidoc（npm是啥？？？自己?jiǎn)柷岸送瑢W(xué)吧。。）

npm install apidoc -g

安裝http-server

npm install http-server -g

2.給接口添加文檔（官方示例），添加在Controller入口方法前面。

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */

3.創(chuàng)建apidoc.json(官方示例)

{
  "name": "example",
  "version": "0.1.0",
  "description": "apiDoc basic example",
  "apidoc": {
    "title": "Custom apiDoc browser title",
    "url" : "https://api.github.com/v1"
  }
}

4.生成apiDoc

apidoc -i app/Http/Controllers -o apidoc/

5.運(yùn)行

http-server api/doc

補(bǔ)充備注

參考

http://apidocjs.com/

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

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

相關(guān)文章

Web API 文檔生成工具 apidoc

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

sushi 2019-08-15 13:47 評(píng)論0 收藏0
利用apidoc維護(hù)api接口文檔

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

hiyayiji 2019-06-28 13:50 評(píng)論0 收藏0
利用apidoc維護(hù)api接口文檔

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

biaoxiaoduan 2019-08-21 16:41 評(píng)論0 收藏0
利用apidoc維護(hù)api接口文檔

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

shaonbean 2019-07-30 14:42 評(píng)論0 收藏0