ApiDoc的使用

ityouknow 发布于2019-06-28 18:39 / 2228人阅读

摘要：说明是一个接口文档，它的创建方式是基于你的源代码的接口备注。我们只需要给接口写好相应的文档，然后使用生成接口文档工具生成文档，便于管理和查看。配置方式安装是啥自己问前端同学吧。。创建官方示例生成运行补充备注参考

说明

apiDoc creates a documentation from API annotations in your source code

apiDoc是一个接口文档，它的创建方式是基于你的源代码的接口备注。我们只需要给接口写好相应的文档，然后使用apiDoc生成接口文档工具生成文档，便于管理和查看。

配置方式

1.安装apidoc（npm是啥？？？自己问前端同学吧。。）

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.创建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.运行

http-server api/doc

补充备注

参考

http://apidocjs.com/

服务器托管云服务器 apidoc 数组的使用字典的使用控件的使用

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/28508.html

Web API 文档生成工具 apidoc

摘要：实现接口文档编写工作，有很多种方式，例如通过文档编写，或者通过进行维护。这里，笔者想分享另一个文档生成工具。此外，可以支持多种语言，，，，，，。查询签收预警策略查询签收预警策略平台类型商家名称最后，我们在终端输入命令进行文档生成。原文地址：梁桂钊的博客在服务端开发过程中，我们需要提供一份 API 接口文档给 Web 端和移动端使用。实现 API 接口文档编写工作，有很多种方式，例...

sushi 2019-08-15 13:47 评论0 收藏0
利用apidoc维护api接口文档

摘要：什么是是一个轻量级的在线接口文档生成系统，支持多种主流语言，包括和等。使用者按照要求书写相关注释，就可以生成可读性好界面美观的在线接口文档。双击文件夹下的，就能看到文档了。什么是apidoc apidoc是一个轻量级的在线REST接口文档生成系统，支持多种主流语言，包括Java、C、C#、PHP和Javascript等。使用者按照要求书写相关注释，就可以生成可读性好、界面美观的在线接...

hiyayiji 2019-06-28 13:50 评论0 收藏0
利用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