有没有好的 api 文档管理系统？

V2EX = way to explore

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

现在注册

已注册用户请登录

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

需求如下：
1.可部署成web页面
2.可用markdown书写api文档
3.有后台，可以直接在网站上添加api

API

Markdown

文档

24 条回复 • 2015-09-07 12:39:55 +08:00

Livid

MOD

2014-12-18 21:59:38 +08:00

https://dash.readme.io/

可以做出很像 Stripe 文档网站的 API 文档站。

aveline

2014-12-18 22:08:20 +08:00

http://apiary.io/
http://apidoc.io/

不需要后台的话，试试这个 http://tripit.github.io/slate/

2014-12-18 22:16:58 +08:00

关注

subpo

2014-12-18 22:17:25 +08:00

我希望是面向内部使用的，多项目的api文档，而不是一个项目介绍文档

subpo

2014-12-18 22:30:03 +08:00

@aveline
@Livid
我希望是面向内部使用的，多项目的api文档，而不是一个项目介绍文档，最好是能部署到自己服务器上的开源的项目（毕竟不想让别人看到私有的api文档），要求好像挺苛刻的，有吗...

harryert

2014-12-18 22:32:47 +08:00

mark，我也想知道。。。

lululau

2014-12-18 22:33:59 +08:00

Github Enterprise

subpo

2014-12-18 22:36:33 +08:00

@aveline http://apidoc.io/ 很符合我的需求，要是这个网站能支持只有固定的登录用户才能看到文档就好了...

efi

2014-12-18 22:43:38 +08:00 via Android

Markdown写api？如果你写过就知道与Markdown语法搏斗的痛苦。试试列表和代码混写。

youyongsong

2014-12-18 23:09:44 +08:00

How do you document your APIs? http://www.infoq.com/research/api-documentation
个人觉得Swagger很不错，还可以直接集成到Django,Flask等框架里，有点像KSS。

janxin

2014-12-18 23:40:15 +08:00

同意 @efi 的说法，markdown排版某些时候还是满痛苦的

humiaozuzu

2014-12-18 23:49:12 +08:00

用过好多，发现还是 confluence 好用。。。

yylyyl

2014-12-19 02:01:42 +08:00 via iPhone

Confluence +1

JamesRuan

2014-12-19 02:54:39 +08:00 via Android

自己撸了一个，没后台，没多项目，不支持markdown，但是支持一个比markdown更适合排版的自己发明的语言。

egen

2014-12-19 08:59:04 +08:00

mark一下，之前一直用 markdown 写文档，基本可以满足需求，不过觉得写的重复性的东西有点太多，看看有没有更好的方案

XinRen

2014-12-19 10:02:26 +08:00

关注

subpo

2014-12-19 11:41:01 +08:00

你们只收藏不贡献！
markdown不是必须，只要有个足够好用的编辑器就可以

tanran

2014-12-19 14:15:44 +08:00

apidoc很好用

KMHook

2014-12-19 15:26:14 +08:00

mark，学习

kimmykuang

2014-12-19 15:57:12 +08:00

mark下，回去细细观之

lguan

2014-12-20 02:35:53 +08:00

我用redmine写过api文档，就是textile，用github的写过，就是markdown，最后发现，还是confluence的最好用，markdown我很喜欢用，但是有些东西不好做，比如，表格

zealic

2014-12-20 14:51:04 +08:00

https://github.com/gollum/gollum

with:
GitHub Flavored Markdown

magicrolan

2015-03-19 16:01:43 +08:00

以后看看吧
现在我也是迷茫

qw0258

2015-09-07 12:39:55 +08:00

mark ，学习