API生成工具

Question

有没有什么工具可以快速生成带导航的HTML API文档
其实就是想平时记一些代码段,然后以此生成带导航的类似API的文档,方便以后查阅开发

Answer 1

MarkPad编辑器

Answer 2

@朴灵 大大写的 doxmate，完全符合你要求。

生成文档只需要一行：

doxmate build

你可以看看这个例子，这是我用 doxmate 搭的个人 Wiki

如果这个还不够，可以选择： Daux.io

Answer 3

用GitBook来写吧。虽然他们家编辑器建立章节时对中文有点小问题，但生成的效果还是不错的。https://www.gitbook.io/

Answer 4

sphinx 可以试试
官网 http://sphinx-doc.org/
中文版 http://start-up-python.readthedocs.org/en/latest/index.html

Answer 5

https://github.com/gongwalker/ApiManager.git
如你所愿

Answer 6

这个还不错： http://apizza.cc?f=sf 模拟请求，调试。文档生成等等

Answer 7

javadoc phpdoc jsdoc pydoc……

几乎任何语言都有 <语言>doc 项目，可以从注释中生成各种格式的API文档

---

仔细一看，题主的“其实”后面和前面完完全全事两个不同的需求……前一半生成代码API文档的回答事上面那个。后一半的需求其实是snippet管理，以sublime为首的各种编辑器，mac下的dash乃至evernote都可以用，随个人习惯。HTML的snippet集用起来太不方便了吧……

Answer 8

Swagger

Demo:
http://petstore.swagger.wordnik.com

)

Answer 9

好多啊

我也来一个犀鸟

Answer 10

不知道 doxygen 能否满足你的要求

Answer 11

很多API doc生成工具生成doc需要重度依赖代码里加注解的方式，并且不支持自动化测试RESTful API。

之前习惯用一款名字为 WisdomTool REST Client，它能够基于测试过的历史记录自动生成精美的RESTful API文档，完全不用在代码里加注解，支持自动化测试RESTful API，输出精美的测试报告。
轻量级的工具，功能却很精悍哦！

https://github.com/wisdomtool...

Most of API doc tools do not support automated testing.

Once used a tool called WisdomTool REST Client supports automatically generating exquisite RESTful API documentation based on history testing cases without adding annotations to the code, it also supports automated testing, and outputs exquisite report.

Lightweight tool with very powerful features!

https://github.com/wisdomtool...

Answer 12

自荐一个API文档生成工具：JApiDocs

它是一个开源的 SpringBoot API 文档生成工具，无需额外注解，轻松集成。目前有 800+star，已经有不少小伙伴在使用了，并且有一个活跃的微信反馈群。

如果你已经厌烦 Swagger 满屏的注解和额外的工作量，你不妨一试！

功能亮点

1. 基于源码解析，无侵入性（也支持解析 jar，但需要内部依赖）；
2. 支持多种格式导出（ Html 、Markdown ）；
3. 直接不同版本比较；
4. 同步生成 Android 和 iOS Model 类；
5. 支持中文和英文版本导出；
6. 支持自定义特性扩展。

相关链接

在线示例：点击示例

文档主页：JApiDocs 中文文档

GitHub: GitHub 仓库

点个小星星，收藏一下？

Answer 13

apemesh.com
他们使用CDIF架构后支持API文档的自动化生成和测试。