API生成工具

naive

12651915

发布于
2014-06-25

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

文档生成

阅读 51.4k

13 个回答

得票最新

edagarli

4.3k72953

发布于
2014-06-25

✓ 已被采纳

MarkPad编辑器

GeekPlux

1.1k11

发布于
2014-06-27

更新于
2014-06-27

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

生成文档只需要一行：

doxmate build

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

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

Easy

17411

发布于
2014-06-25

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

rsj217

4.9k3816

发布于
2014-06-25

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

路人庚

191

发布于
2015-09-22

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

maclinuxp

452

发布于
2016-09-21

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

mcfog

21.9k11443

发布于
2014-06-25

更新于
2014-06-25

javadoc phpdoc jsdoc pydoc……

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

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

Alan

50414

发布于
2014-06-26

Swagger

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

)

rose1988c

2313

发布于
2014-07-03

好多啊

我也来一个犀鸟

CyberLion

发布于
2014-07-20

新手上路，请多包涵

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

WitPool

173

发布于
2017-11-27

更新于
2018-01-04

很多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...

图片描述