V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member Sign In
• 请不要在回答技术问题时复制粘贴 AI 生成的内容
This topic created in 3307 days ago, the information mentioned may be changed or developed.
遇到一个尴尬的问题，我司 API 文档都是使用 markdown 来写的，然而是放在项目目录下面的 README.md 中，但是多人人多的时候修改起来就比较麻烦，就想用有没有一种在线的 API 文档管理程序撒的，石墨固然好，好像不支持 Markdown 所以没打算用。
哎。 Fuck
Supplement 1 · Apr 14, 2017
看了各位的评论，表示API文档还是可以独立部署代表比较好，我可不想把自己程序的API说明丢在别人家。
其次，看了下swagger，感觉UI挺不错，抽时间研究下。
我司下载就是放在仓库下面的README.md中。
 |
1
xuanyan Apr 13, 2017
我们用的 mediawiki 搭建的 api 接口词条
|
 |
2
lawmil Apr 13, 2017  1
既然是 md 写的，推荐个系统 docsify 很方便，样式默认 vue 也可以改其他
|
 |
5
hekunhotmail Apr 13, 2017
wiki 不谢
|
 |
6
zi Apr 13, 2017
 我司用 word 。。真的要哭出声来 |
 |
7
AlisaDestiny Apr 13, 2017
|
 |
9
ansheng OP @AlisaDestiny 贵了点，哈哈。
|
 |
10
domty Apr 13, 2017
confluence
|
 |
11
tpsxiong Apr 13, 2017
|
 |
12
linoder Apr 13, 2017
swagger
|
 |
13
flyingghost Apr 13, 2017
www.xiaoyaoji.com
可内网部署 |
 |
14
h4x3rotab Apr 13, 2017
Google 是和源码目录放在一起的 md 文件，同样加入版本管理，代码审查。然后再搭配一个搜索。
|
 |
15
lusyoe Apr 13, 2017 via iPhone
swagger +1
|
 |
16
crossoverJie Apr 13, 2017
有 doc 和 wiki
|
 |
17
tkisme Apr 13, 2017
swagger +1
|
 |
18
nashxk Apr 13, 2017
confluence 。不过没用 markdown ，而且改版的时候更新也不是很及时。。
|
|
19
ansheng OP @flyingghost 表示打不开，就是需要内网部署的。
|
|
21
ansheng OP |
 |
22
kooze Apr 13, 2017 4
口耳相传
|
 |
23
zhuf Apr 13, 2017
apidoc
|
 |
25
snriud Apr 13, 2017
最开始是写在 wiki 里，认认真真，完完整整，慢慢地就不维护了，有人要接口文档的话就用 postman 请求一次，截图发给谁。。。
|
 |
27
wudanyang Apr 13, 2017
wiki, 不会调格式
|
 |
28
gengqiupeng Apr 13, 2017
小幺鸡在线文档。不过不是用 markdown 写的
|
 |
29
kaka8wp Apr 13, 2017
有部分文档但基本上不是最新的，最新的也是靠口耳相传
|
 |
30
ivvei Apr 13, 2017
没有文档。自己翻代码
|
 |
31
izoabr Apr 13, 2017
口口相传
|
 |
32
huigeer Apr 13, 2017
apidoc + 1
|
 |
33
ArthurKing Apr 13, 2017
swagger +1
|
|
34
huigeer Apr 13, 2017
更正： ShowDoc
|
 |
35
qiu0130 Apr 13, 2017 via Android
难道没有用 tower 的?
|
 |
36
klgd Apr 13, 2017
showdoc + apidoc
showdoc 是前人用的， coding+编辑维护不是方便，后来用 apidoc ，注释直接写在 code 里，然后命令生成，虽然注释在编写时也不是太方便，但感觉对 coding 和维护好一点儿 |
 |
37
orderc Apr 13, 2017
gitbook
|
 |
40
freezhan Apr 13, 2017
swagger+1
|
 |
41
strongcoder Apr 13, 2017
我司用 word 。。快被气死
|
 |
42
Observer42 Apr 13, 2017
swagger
|
 |
44
subdued Apr 13, 2017 4
我司 API 文档靠口口相传
|
 |
45
guodont Apr 13, 2017
swagger +1
apidoc +1 |
 |
46
virusdefender Apr 13, 2017 1
口口相传
心有灵犀 |
 |
47
xxdd Apr 13, 2017
口口相传
心有灵犀 (●'◡'●)ﾉ♥ |
 |
48
prasanta Apr 13, 2017
用 mkdocs+git
|
 |
49
Ouyangan Apr 13, 2017
swagger+1
|
 |
50
qdpoboy Apr 13, 2017
喊！呀
|
 |
52
Vvfan Apr 13, 2017
看来不止我们用 word /(ㄒoㄒ)/~~
|
 |
53
kisnows Apr 13, 2017
Word Wiki 有道云 + 口口相传
|
 |
54
nextbox Apr 13, 2017
RAP
|
 |
55
imherer Apr 13, 2017
|
 |
56
ydq419453527 Apr 13, 2017
|
 |
57
Blazings Apr 13, 2017 via Android
口口相传牛逼
|
 |
58
auhah Apr 13, 2017
想起了前前前公司，我刚工作的时候
CTO 特别屌 自己撸了一套 API 网站 还以为是 IT 公司标配 后来几个公司 tmd 全是 word |
 |
59
mfu Apr 13, 2017
写 WORD 里扔 SVN 上。 T_T
|
 |
60
WhoMercy Apr 13, 2017 via Android
遇到过 word 生成 html 扔内网服务器，给个固定网址的……
|
 |
61
nameldk Apr 13, 2017
文档是写在代码里，然后有专门处理程序会把代码的文档提取出来，生成 api 文档，同时生成测试工具:)
|
 |
62
a412739861 Apr 13, 2017
@kooze #22 还不错了，我们是代码讲那过去的故事……
|
 |
63
zhleonix Apr 13, 2017
用 Swagger 或者 RAML 写 YAML 规范，自动产生文档和代码。
|
 |
64
xieweizhi007 Apr 13, 2017 via iPhone
apiary
|
|
65
xieweizhi007 Apr 13, 2017 via iPhone
更正： apiary
|
 |
66
G900 Apr 13, 2017
GitLab ，和代码分开，做一个单独的 doc 库，用 markdown 写，管理方便
|
 |
68
orvice Apr 13, 2017
swagger :)
|
 |
69
xu1ming Apr 13, 2017 via iPhone 1
我司 google doc
|
 |
70
mingyun Apr 13, 2017
dokuwiki
|
 |
71
loveuqian Apr 13, 2017 via iPhone
就一条 curl 命令
|
 |
72
Jakesoft Apr 14, 2017
竟然没有 sphinx ，专业文档编写 100 年
|
 |
73
zzyzxd Apr 14, 2017
前公司是把 git 目录 mount 到一个 MkDocs 的 container 里……
|
 |
74
jwangkun Apr 14, 2017 via Android
没人推荐小幺鸡么？
|
 |
75
yalanaika Apr 14, 2017
html - chm
|
 |
76
libook Apr 14, 2017
个人觉得 API 文档维护的最大问题是忘记维护，或者有时候赶时间就懒得维护，所以个人倾向于将 API 文档与代码放在一起。
我们是 JS 全栈， JS 有一套 JSDoc 标准，适用于非 API 场景的文档编写，依照这个标准，有一个 APIDoc 工具，可以用类似 JSDoc 的方式在代码中用注释编写 API 文档，但是在实际应用过程中感觉不适合我们的应用场景，所以自己写了一个 URIDoc https://www.npmjs.com/package/uridoc 目前还是 v1 的初级阶段，欢迎 Fork 和 PullRequest |
 |
77
eurry Apr 14, 2017
https://www.showdoc.cc/
showDoc |
 |
78
hareandlion Apr 14, 2017 via iPhone
口口相传 +1
|
 |
79
tangbl93 Apr 14, 2017
word + 1
|
 |
81
yellowV2ex Apr 14, 2017
腾讯微信的公众号开发文档就是 word ，最开始的时候，里面引号还是中文的。
|
|
82
yellowV2ex Apr 14, 2017
|
 |
83
loading Apr 14, 2017
自己看代码
|
 |
84
zongren Apr 14, 2017 1
QQ 聊天记录
|
 |
85
zcwlwen Apr 14, 2017
写 markdown 扔在 gitlab 上
|
 |
86
BearD01001 Apr 14, 2017
额，公司的 boss 系统有 API 文档检索功能，虽然界面粗糙，不过挺实用
|
 |
87
HuntBao Apr 14, 2017 1
我司自己开发的接口管理系统： https://nei.netease.com/
|
 |
88
silenceeeee Apr 14, 2017
写 word 扔 svn ，己准备离职！
|
 |
89
stackboom Apr 14, 2017
之前 swagger ，现在 RAP
|
 |
91
Raidal Apr 14, 2017
在用 [aglio]( https://github.com/danielgtaylor/aglio) ，不过数据多了后会有一点点慢。
|
 |
92
roricon Apr 14, 2017
sphinx 为啥没人提起呢.
|
 |
93
chipmuck Apr 14, 2017
https://study.congcong.us/t/340795 难怪看的眼熟。。。。
|
 |
94
heaunter Apr 14, 2017 via Android
必须小幺鸡啊……团队已从 RAP 切换到小幺鸡了
|
 |
96
magiclobster Apr 14, 2017
为什么不用 oschina 啊..
|
 |
97
changs1986 Apr 14, 2017
apidoc
|
 |
98
andychen1 Sep 4, 2020
api-mom.com 我司用这个
|
Select Language