接口文档生成工具—apidoc

warmcheng 发布于2019-08-21 17:09 / 1963人阅读

摘要：使用方法我们以的项目为例创建项目文档项目描述项目文档我们在文件夹下建立文件夹，用于书写接口注释说明例如新闻详情新闻结果标识结果说明结果数据成功调用生成命令以上命令的意思是读取文件夹下的配置，输出说明文档到文件夹打开生成后的即可

apiDoc在您的源代码中通过创建API注释从而生成api说明文档。
http://apidocjs.com/#param-ap...

使用方法

我们以express的项目为例

1 创建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 结果标识
 * @apiSuccess {String} message 结果说明
 * @apiSuccess {Object} data 结果数据
 * @apiSuccessExample Success-Response:
 *     HTTP/11 200 OK
 *     {
 *       "code": 1,
 *       "mess": "成功",
 *       "data": {}
 *     }
 */

3 调用生成命令

apidoc -i routes/ -o public/apidoc/

以上命令的意思是读取routes文件夹下的api配置，输出api说明文档到public/apidoc/文件夹
打开生成后的index.html即可

GPU云服务器云服务器接口文档生成工具 api接口文档工具文档生成 python生成文档

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

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

Web API 文档生成工具 apidoc

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

sushi 2019-08-15 13:47 评论0 收藏0
开源的api文档管理系统

摘要：国外的话国内的国内开源的非常好用的一款文档管理系统，安装也非常方便，只需将源代码放到项目目录下自动安装运行即可，不要要注意版本必须大于界面简洁功能强大的阿里的接口管理工具，开源免费，接口自动化，数据自动生成，自动化测试，企业级管理。在项目中，需要协同开发，所以会写许多API文档给其他同事，以前都是写一个简单的TXT文本或Word文档，口口相传，这种方式比较老土了，所以，需要有个api...

zsirfs 2019-06-27 14:58 评论0 收藏0
ApiDoc的使用

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

ityouknow 2019-06-28 18:39 评论0 收藏0
php - Api 接口写法规范和要求

摘要：前言说明是一个文档生成工具可以根据代码注释生成文档从注释生成静态网页文档，不仅支持项目版本号，还支持版本号安装系统需要安装略安装有些系统需要权限来安装执行生成这个文档的生成规则是对于项目中我们使用封装了一个函数生成文档注意分组名不前言说明apidoc是一个API文档生成工具, apidoc可以根据代码注释生成web api文档, apidoc从注释生成静态html网页文档，不仅支持...

k00baa 2019-06-28 14:21 评论0 收藏0