- 公司准备使用 swagger，基于注解的方式，但是发现多个项目无法集成，很不方便
- swagger-ui 中没有接口的搜索功能
请问各位还有啥比较好用的轮子？
This topic created in 3340 days ago, the information mentioned may be changed or developed.
Supplement 1 · Sep 12, 2017
@All 各位别搞我啊，得讲道理，我就不信大公司也是口口相传的？
Supplement 2 · Sep 13, 2017
看到各位的回复，我也是放心了！当我在接手别人代码的时候的心情也能平复下了！
119 replies • 2018-11-29 20:23:15 +08:00
 |
byucSep 12, 2017
1
口口相传
|
 |
qinxiSep 12, 2017
2
|
 |
yoa1q7ySep 12, 2017
3
口口相传+1
|
 |
sudozSep 12, 2017
4
confluence
|
 |
Hypn0sSep 12, 2017
5
confluence + 1
|
 |
gaayyySep 12, 2017
6
靠猜
|
 |
ZeoKarlSep 12, 2017
7
给你一个眼神,自己体会.🌚
|
 |
fengxuejianshiSep 12, 2017 via iPhone
8
意念
|
 |
aaxccSep 12, 2017 via iPhone
9
当然是打印出来贴在公司大门上，每天程序猿进门背一个借口，背错的扣工资
|
 |
cutloveSep 12, 2017
10
apizza
|
 |
irgilSep 12, 2017
11
swagger，或者公司自研的。
|
 |
oranchoSep 12, 2017
12
protobuf / grpc 的 proto 文件
|
 |
AndyJiaSep 12, 2017 via Android
15
openapi
|
 |
geminiSep 12, 2017
16
word 文档不挺好的么
|
 |
iyaozhenSep 12, 2017 via Android
17
wiki，先定接口再开发
|
 |
crossoverJieSep 12, 2017
18
之前 confluence 现在 swagger
|
 |
hasbugSep 12, 2017
19
口口相传+1
|
 |
m939594960Sep 12, 2017
20
gitlab 的 wiki 功能
|
 |
xiaolanglangSep 12, 2017
21
口口相传
|
 |
fbzlSep 13, 2017 via iPhone
22
口口相传，心灵感应
|
 |
JackerissSep 13, 2017 via iPhone
24
这个全看悟性
|
 |
junbguistarSep 13, 2017
25
接口多就自己搭 wiki 和 swagger 少就口口相传
|
 |
49degreeSep 13, 2017
26
RAP
|
 |
fan123199Sep 13, 2017
27
word 文档
|
 |
LucupsSep 13, 2017
28
不同方式的文档都有各自的优劣和使用场景，我主要考虑沟通成本，哪种方式沟通成本小用哪种。
目前在公司用 confluence 手写，一个接口一个页面，其他部门人来要时直接丢链接。 PS：Swagger 默认的 UI 不是很好用。有同感的可以考虑这个项目 https://github.com/jensoleg/swagger-ui。 |
|
LucupsSep 13, 2017
29
|
 |
TyrionSep 13, 2017
30
confluence + 1
|
 |
bomblessSep 13, 2017 via Android
31
写代码注释里面的，靠自觉，很多人不写的。
听说大公司都是靠口口相传 |
 |
feiyuanqiuSep 13, 2017 via Android
32
@Lucups 我最近刚好在改这个 ui。它有个问题是把接口参数放在 div 的属性里，导致没法选择及复制，而且参数名长一点的话就显示不全。另外我也不太喜欢它调用接口时单独弹出一个 modal 的方式
|
 |
msg7086Sep 13, 2017
33
早已失传……
|
 |
motaiSep 13, 2017 via iPhone
34
rap，word，内部的 wiki 系统
|
 |
xtaxcySep 13, 2017 via Android
35
小幺鸡
|
 |
caijihui11Sep 13, 2017
36
apidoc
|
 |
NSAtoolsSep 13, 2017
37
口口相传
|
 |
icycaiSep 13, 2017 via Android
38
口口相传+1
|
 |
kindjeffSep 13, 2017 via iPhone
39
传嫡不传庶，传长不传幼，传男不传女
|
 |
justiceloveSep 13, 2017
40
搜索就是 control + F
|
 |
caizhendiSep 13, 2017
41
后台自己维护个文档
|
 |
cnbattleSep 13, 2017
42
口口相传.gif
|
 |
simonlu9Sep 13, 2017
43
eo-linker
|
 |
chocotanSep 13, 2017
44
一开始是口口相传，自从搭了 confluence 后大多用这个了
|
 |
ClarencepSep 13, 2017
45
我司是我自己用 Laravel 写了一个基于 Markdown 的文档系统，支持文档模版，支持复制粘贴图片，支持全文检索，支持用户权限管理。开发用时约 3 天。
话说这种东西还是自己做的用着舒服：） 上家用的 confluence 也很不错，不过现在这家没买，懒得搞破解版，所以还是自己动手丰衣足食。 |
 |
lrh3321Sep 13, 2017
46
口口相传+1
忘记了就去看聊天记录 |
 |
timelessgSep 13, 2017 via Android
47
当然是微信了
|
 |
keepcleargasSep 13, 2017
50
slate + git
|
 |
xiaowanggeSep 13, 2017
51
口口相传+聊天记录
+1  |
 |
vjnjcSep 13, 2017
52
wiki +1
swagger 的话不用他一整套不方便吧，还不如 wiki 上格式写规范点 |
 |
teaaaSep 13, 2017
53
wiki +1
强迫症觉得必须有统一的接口文档啊 很方便高效啊 要不怎么推锅 |
 |
WendellSunSep 13, 2017
54
口口相传+1
|
 |
noNOnoSep 13, 2017
55
confluence + 1
|
 |
imhererSep 13, 2017
56
https://github.com/lord/slate 这个。支持搜索
|
 |
codeyungSep 13, 2017
57
confluence 自写（之前项目都是自己 wiki 手写的 很多 ） 现在的 swagger 做模块服务时候用
|
 |
fork3rtSep 13, 2017
58
swagger 或者 手写 markdown
|
 |
liuqitodaySep 13, 2017
59
口口相传+1
|
 |
YiBaZhuangYuanSep 13, 2017
60
GitLab
|
 |
my3157Sep 13, 2017
61
昨天正好也在看这个, 转了一圈, 目前做 api 文档管理的有 nei easyapi eolinker apizza RAP , 体验了其中 eolinker 和 apizza, 最后选择了 postman, 不但能做文档, 顺便还写了 api 测试 , 免费档已够用
|
 |
lifeforwaterSep 13, 2017
62
小幺鸡
|
 |
zjsxwcSep 13, 2017 via Android
63
邮件
|
 |
xxddSep 13, 2017
64
看我口型
|
|
oranchoSep 13, 2017
65
@lgh
如果你用 gRPC 的话，可以直接将 proto 文件中定义的 service 名传给 invoke 函数。对于使用 protobuf 的 RESTful API，我司一般的方法是在对应的 message 前的注释中写上对应的 URI。 |
 |
leaybcSep 13, 2017
66
我在用 swagger 然后配合第三方的 UI . 感觉挺好的
|
 |
silovSep 13, 2017
67
markdown 丢 git 上 ==
|
 |
SimcyberSep 13, 2017
68
口口相传+1024
|
 |
ezrealSep 13, 2017 via iPhone
70
口口相传
|
 |
laudukangSep 13, 2017
71
口口相传
|
 |
VindroidSep 13, 2017
72
GitLab
|
 |
qscqeszeSep 13, 2017
73
口口相传，最多写个 wiki 解释一下
|
 |
zhygkxSep 13, 2017
74
|
 |
dreamwarSep 13, 2017
75
心灵感应
|
 |
owenliangSep 13, 2017
76
gitlab README
|
 |
c0878Sep 13, 2017
77
mkdocs
|
 |
l00tSep 13, 2017
78
Excel + svn
|
 |
siteshenSep 13, 2017
79
我们公司使用的 swagger，不过默认的“先设计好 *所有* API 格式，再生成代码模版”的方式并不适合我们（因为随时需要增加新的 API 和扩展现有的 API ），我们的使用方式如下：
1. python/go 代码按正常逻辑写，如： // method, url, input format, output format routes = [("POST", "/me/update", UpdateMeForm, MeResponse, ["tag1", "tag2", ...])] 2. 自定义函数 ToSwaggerJSON(method, url, request_form, response_object) 生成对应的 swagger.json 文件，然后交给 swagger-ui 处理其余事情； 3. 客户端在浏览器查看 API 文档，几乎没有进行过 API 问题的沟通。 ps: 最大的难点在于 ToSwagger() 函数，python/go 都没找到合适的库，花了不少的时间（印象中 python/go 各一周？），自己查看 swagger 文档实现了部分接口格式。 |
|
LucupsSep 13, 2017
80
@feiyuanqiu 改好了提 pull request 回馈社区~~
|
 |
mahengyangSep 13, 2017
81
多个接口之间的关系怎么体现呢？
|
 |
rb6221Sep 13, 2017
82
RAP 啊
|
 |
luiliSep 13, 2017
83
confluence
|
 |
tjxiterSep 13, 2017
84
口口相传+1
|
 |
darklhSep 13, 2017
85
前公司用 rap
|
 |
zpf124Sep 13, 2017
86
前段时间我们要补文档，找了半天最终用了 swagger。
话说当时还看到一个 Read The Docs 不知道有没有人用这个 |
 |
acrosSep 13, 2017
87
口口相传的各位····
兼职公司吟游诗人职位吗？ |
 |
JustCJSep 13, 2017
88
slate
|
 |
MushishiXianSep 13, 2017
89
有时候更新了文档还是要去通知下,通知过程中可能就直接说改了哪里,也可能就是口口相传了,网易那个 nei 不知道怎样,体验了下感觉还行
|
 |
v2chouSep 13, 2017
90
给你一个眼神,自己体会
|
 |
zhouyou457Sep 13, 2017
91
正常情况下写 md，然后导出 pdf 放 svn 上。。
紧急情况下，口口相传，记不清的自己看聊天记录[doge] |
 |
xjmrootSep 13, 2017
93
showdoc 管理的，蛮方便
https://www.showdoc.cc/1666386?page_id=15335212 |
|
94
公司内部部署个，超级简单，还能导出 word
https://github.com/star7th/showdoc |
1 |
teaaaSep 13, 2017
95
dokuwiki 也很好用啊 可以自动生成目录
|
 |
WystenSep 13, 2017
96
眼神体会
|
 |
kk941kkSep 13, 2017
97
没有文档，不用管理。。
|
 |
jadec0derSep 13, 2017
98
thrift / confluence ( http)
|
 |
SvenWongSep 13, 2017
99
口口相传 +1
|
 |
HilongSep 13, 2017 via Android
100
300 多个接口，没有文档，就一个 postman 调用事例，然后口口相传
|
Select Language