APIDOC

apidoc是一个简单的RESTful API文档生成工具，它从代码注释中提取特定格式的内容生成文档。支持诸如GO、Java、C++、Rust 等大部分开发语言。

apidoc拥有以下特点

1.跨平台，linux. windows、 macOS等都支持;
2.支持语言广泛，即使是不支持，也很方便扩展;
3.支持多个不同语言的多个项目生成一份文档;
4.输出模板可自定义;
5.根据文档生成mock数据;

apidoc安装使用

安装：npm install -g apidoc
注释生成：
apidoc根据注释生成文档，这就需要我们有好的注释规范。
vscode有一个注释插件可以更方便的生成注释：ApiDoc Snippets

生成模板之后在填入具体的注释信息。

eg：完成的注释：

/*** * @api {post} /api/user user* @apiName addUser* @apiGroup usergroup* @apiVersion  1.0.0* * * @apiParam  {String} username 用户名* @apiParam  {String} password 密码* @apiParam  {Number} age 年龄* @apiParam  {File} avatar 头像* * @apiSuccess (200) {number} ok 表示成功字段* * @apiParamExample  {type} Request-Example:* {*     username : "yang",*     password:"123456",*     age:100,*     avatar:File* } * * @apiSuccessExample {type} Success-Response:* {*      ok:1* }* */

生成文档命令：
apidoc -i 要扫描的带注释的文档目录 -o 要生成的文档目录
eg:
apidoc -i src/ -o doc/
apidoc -i .\routes\ -o .\doc

执行命令生成的文档：

在浏览器打开index.html就可以查看生成的文档。

文档默认显示0.0.0要点击到1.0.0才会显示内容。
可以做相关配置，使文档直接显示1.0.0.
与doc平级新建apidoc.json文件，输入如下内容：（都可以自定义）

{"name":"后台系统接口文档","version": "1.0.0","description": "关于后台系统的接口文档描述","title":" 企业网站定制系统"
}

APIDOC- API文档生成工具——node相关推荐

apiDoc 一款很不错api文档生成工具
apiDoc 一款很不错api文档生成工具,在开发接口的时候,需要给同事看相应的接口文档.给大家推荐一个生成文档的工具--apiDoc,最后生成的文档以网页的形式发布,方便快捷,便于阅读. 创建项目目 ...
猿创征文｜小而巧的API文档生成工具之smart-doc
文章目录 smart-doc介绍 smart-doc特性 smart-doc的最佳搭档谁在使用smart-doc smart-doc的优缺点 smart-doc和swagger区别比较 smart- ...
php自写api文档生成工具
框架改版后的第二个版本定下来了,这两天也比较轻松,于是就折腾给项目建个好看的api文档. 各种折腾.先是折腾phpDocumentor2,用phpdoc开源工具来建立文档,好不容易安装成功,各个模板都 ...
java smart算法_Java Restful API 文档生成工具 smart-doc
谁说生成api文档就必须要定义注解? 谁说生成接口请求和返回示例必须要在线? 用代码去探路,不断尝试更多文档交付的可能性. 如果代码有生命,为什么不换种方式和它对话! 一.背景没有背景.就自己做自己 ...
springboot的api_【粉丝投稿】无需额外注解的 SpringBoot API文档生成工具
点击上方"蓝字"关注我们吧! JApiDocs是一个无需额外注解.开箱即用的SpringBoot接口文档生成工具. 编写和维护API文档这个事情,对于后端程序员来说,是一件恼人但又 ...
android api文档_【粉丝投稿】无需额外注解的 SpringBoot API文档生成工具
点击上方"蓝字"关注我们吧! JApiDocs是一个无需额外注解.开箱即用的SpringBoot接口文档生成工具. 编写和维护API文档这个事情,对于后端程序员来说,是一件恼人但又 ...
[aspnetcore.apidoc]一款很不错的api文档生成工具
简单徐速一下为什么选用了aspnetcore.apidoc 而没有选用swagger 最初我们也有在试用swagger,但总是有些感觉,感觉有点不满意,就但从api文档角度来说,从前后端文档沟通角度来 ...
Api文档生成工具与Api文档的传播（pdf）
点击查看apidoc生成文档demo 1 环境和工具 win10 apidoc:注释生成api文档 wkhtmltopdf:apidoc生成的是html,不适合传播,于是通过wkhtmltopdf将h ...
一款零注解侵入的 API 文档生成工具，你用过吗？
以下文章来源方志朋的博客,回复"666"获面试宝典介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart ...

APIDOC- API文档生成工具——node

文章目录

APIDOC

apidoc拥有以下特点

apidoc安装使用

APIDOC- API文档生成工具——node相关推荐

最新文章

热门文章