apidoc 生成 RESTful API 的一个小工具

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

爱意满满的作品展示区。

这是一个创建于 3052 天前的主题，其中的信息可能已经有所发展或是发生改变。

一个提取注释生成文档的工。之前撸项目时的一个副产品，目前算是比较完善了。

跨平台， linux 、 windows 、 macOS 等都支持；
支持语言广泛，即使是不支持，也很方便扩展；
支持多个不同语言的多个项目生成一份文档；
输出模板可自定义；

目前已经支持： C#、 C/C++、 Go 、 Java 、 Javascript 、 Perl 、 PHP 、 Python 、 Ruby 、 Rust 和 Swift 。

文档：http://apidoc.tools

仓库在：Github 或是 oschina

文档

生成

支持

apidoc

16 条回复 • 2016-07-12 20:41:21 +08:00

123123

2016-07-11 10:02:42 +08:00

跟 http://apidocjs.com/ 是什么关系？

xnotepad

2016-07-11 10:04:18 +08:00

@123123 没关系，重名了。

murmur

2016-07-11 14:15:21 +08:00

和 swagger 全家桶系列比呢？

xnotepad

2016-07-11 14:29:11 +08:00

@murmur 没那么复杂，就提供了一个命令行工具，可以从源代码里提取特定的注释，然后生成 HTML 或是 json 文档。

fwrq41251

2016-07-11 14:37:25 +08:00

没有 demo 吗，生成的 html 长什么样？

xnotepad

2016-07-11 17:15:25 +08:00

@fwrq41251 http://apidoc.tools/example/doc/index.html 默认模板长这样，非设计出身，弄得有点丑。想好看的话，可以自己设计模板，在配置文件中指定 template 参数就可以了。

puras

2016-07-11 17:23:17 +08:00

能像 Swagger 一样，直接测试么？

xnotepad

2016-07-11 18:03:07 +08:00

@puras 不能，目前定位就是一个文档工具。

lijinma

2016-07-11 18:08:22 +08:00

@xnotepad 如果用还需要加个测试，用不了多少代码，你可以的。

penjianfeng

2016-07-11 18:34:10 +08:00

感觉很赞，已经收藏，感谢分享：-）

xnotepad

2016-07-11 18:49:06 +08:00

@lijinma 之前有过这方面的相法，不过在这方面，肯定不如 postman 之类的工具方便好用，所以就暂时放弃了。**或许**在下个版本会加上去吧。

xuqingkuang

2016-07-12 08:25:35 +08:00

已经 Star

baoguok

2016-07-12 09:46:07 +08:00

感谢,很好用.
一直在用这个生成兼职项目的文档

liteneo

2016-07-12 12:07:02 +08:00 via iPhone

👍

liteneo

2016-07-12 12:22:48 +08:00 via iPhone

Test

fhefh

2016-07-12 20:41:21 +08:00

nice mark