
APIDOC - API 文档生成工具
apidoc 是一个简单的 RESTful API 文档生成工具,它从代码注释中提取特定格式的内容生成文档。支持诸如 Go、Java、C++、Rust 等大部分开发语言,具体可使用 apidoc lang
命令行查看所有的支持列表。
apidoc 拥有以下特点:
- 跨平台,linux、windows、macOS 等都支持;
- 支持语言广泛,即使是不支持,也很方便扩展;
- 支持多个不同语言的多个项目生成一份文档;
- 输出模板可自定义;
- 根据文档生成 mock 数据;
1 | npm install -g apidoc |
注意:
(1) 在当前文件夹下 apidoc.json
1 | { |
(2)可以利用vscode apidoc snippets 插件创建api
- 标题: APIDOC - API 文档生成工具
- 作者: Voun
- 创建于 : 2023-08-04 16:18:00
- 更新于 : 2024-08-13 05:34:32
- 链接: http://www.voun.top/2023/08/04/07APIDOC/
- 版权声明: 本文章采用 CC BY-NC-SA 4.0 进行许可。
评论