github地址：https://github.com/apidoc/apidoc
开源协议：MIT License
Star: 8.7k
开发语言：javascript
用户：未知
推荐指数：★★★★☆
示例地址：https://apidocjs.com/example/#
image.png
apidoc 是一个简单的 RESTful API 文档生成工具，它从代码注释中提取特定格式的内容生成文档。支持诸如 Go、Java、C++、Rust 等大部分开发语言，具体可使用 apidoc lang 命令行查看所有的支持列表。
apidoc 拥有以下特点：
- 跨平台，linux、windows、macOS 等都支持；
- 支持语言广泛，即使是不支持，也很方便扩展；
- 支持多个不同语言的多个项目生成一份文档；
- 输出模板可自定义；
- 根据文档生成 mock 数据；
优点：基于代码注释生成在线文档，对代码的嵌入性比较小，支持多种语言，跨平台，也可自定义模板。支持搜索和在线调试功能。
缺点：需要在注释中增加指定注解，如果代码参数或类型有修改，需要同步修改注解相关内容，有一定的维护工作量。
个人建议：这种在线文档生成工具提供了另外一种思路，swagger是在代码中加注解，而apidoc是在注解中加数据，代码嵌入性更小，推荐使用。
网友评论