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

2014-12-18 21:46:39 +08:00
 subpo
需求如下:
1.可部署成web页面
2.可用markdown书写api文档
3.有后台,可以直接在网站上添加api
5879 次点击
所在节点    程序员
24 条回复
Livid
2014-12-18 21:59:38 +08:00
https://dash.readme.io/

可以做出很像 Stripe 文档网站的 API 文档站。
aveline
2014-12-18 22:08:20 +08:00
xw
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
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
Confluence +1
JamesRuan
2014-12-19 02:54:39 +08:00
自己撸了一个,没后台,没多项目,不支持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下,回去细细观之

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/154958

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX