关于
apidoc 是一个简单的 RESTful API 文档生成工具,它从代码注释中提取特定格式的内容生成文档。支持诸如 Go、Java、C++、Rust 等大部分开发语言,具体可使用 apidoc lang 命令行查看所有的支持列表。
apidoc 拥有以下特点:
- 跨平台,linux、windows、macOS 等都支持;
- 支持语言广泛,即使是不支持,也很方便扩展;
- 支持多个不同语言的多个项目生成一份文档;
- 输出模板可自定义;
- 根据文档生成 mock 数据;
以下是一段简短的 C 语言风格代码下的示例:
![fdc83db6f9d85b93e47475158f25b1b6.png](https://i-blog.csdnimg.cn/blog_migrate/11c2f436fdb58d43366fcf59403aa9a3.jpeg)
使用
环境变量
apidoc 会读取 LANG 的环境变量作为其本地化的依据,若想指定其它语种,可以手动定 LANG 环境变量:LANG=zh-Hant apidoc。在 windows 系统中,若不存在 LANG 环境变量,则会调用 GetUserDefaultLocaleName 函数来获取相应的语言信息。
命令行