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

V2EX = way to explore

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

For Existing Member Sign In

• 请不要在回答技术问题时复制粘贴 AI 生成的内容

This topic created in 4151 days ago, the information mentioned may be changed or developed.

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

API

Markdown

文档

24 replies • 2015-09-07 12:39:55 +08:00

Livid

MOD

PRO

Dec 18, 2014

https://dash.readme.io/

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

aveline

Dec 18, 2014

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

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

Dec 18, 2014

关注

subpo

Dec 18, 2014

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

subpo

Dec 18, 2014

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

harryert

Dec 18, 2014

mark，我也想知道。。。

lululau

Dec 18, 2014

Github Enterprise

subpo

Dec 18, 2014

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

efi

Dec 18, 2014 via Android

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

youyongsong

Dec 18, 2014

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

janxin

Dec 18, 2014

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

humiaozuzu

Dec 18, 2014

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

yylyyl

Dec 19, 2014 via iPhone

Confluence +1

JamesRuan

Dec 19, 2014 via Android

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

egen

Dec 19, 2014

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

XinRen

Dec 19, 2014

关注

subpo

Dec 19, 2014

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

tanran

Dec 19, 2014

apidoc很好用

KMHook

Dec 19, 2014

mark，学习

kimmykuang

Dec 19, 2014

mark下，回去细细观之

lguan

Dec 20, 2014

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

zealic

Dec 20, 2014

https://github.com/gollum/gollum

with:
GitHub Flavored Markdown

magicrolan

Mar 19, 2015

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

qw0258

Sep 7, 2015

mark ，学习