请问各位,公司内部的接口文档是怎么管理的?

2017-09-12 19:48:51 +08:00
 MrXiong
  1. 公司准备使用 swagger,基于注解的方式,但是发现多个项目无法集成,很不方便
  2. swagger-ui 中没有接口的搜索功能

请问各位还有啥比较好用的轮子?

18315 次点击
所在节点    Java
119 条回复
caizhendi
2017-09-13 09:13:38 +08:00
后台自己维护个文档
cnbattle
2017-09-13 09:15:02 +08:00
口口相传.gif
simonlu9
2017-09-13 09:16:24 +08:00
eo-linker
chocotan
2017-09-13 09:17:18 +08:00
一开始是口口相传,自从搭了 confluence 后大多用这个了
Clarencep
2017-09-13 09:19:11 +08:00
我司是我自己用 Laravel 写了一个基于 Markdown 的文档系统,支持文档模版,支持复制粘贴图片,支持全文检索,支持用户权限管理。开发用时约 3 天。

话说这种东西还是自己做的用着舒服:)

上家用的 confluence 也很不错,不过现在这家没买,懒得搞破解版,所以还是自己动手丰衣足食。
lrh3321
2017-09-13 09:20:48 +08:00
口口相传+1

忘记了就去看聊天记录
timelessg
2017-09-13 09:29:45 +08:00
当然是微信了
vlean
2017-09-13 09:42:46 +08:00
@49degree RAP+1 +wiki
a7063888
2017-09-13 09:47:21 +08:00
@lrh3321
口口相传+聊天记录 还是老哥稳

公司用 confluence
keepcleargas
2017-09-13 10:35:01 +08:00
slate + git
xiaowangge
2017-09-13 10:40:27 +08:00
口口相传+聊天记录

+1
vjnjc
2017-09-13 10:40:29 +08:00
wiki +1
swagger 的话不用他一整套不方便吧,还不如 wiki 上格式写规范点
teaaa
2017-09-13 10:43:50 +08:00
wiki +1
强迫症觉得必须有统一的接口文档啊
很方便高效啊
要不怎么推锅
WendellSun
2017-09-13 10:44:11 +08:00
口口相传+1
noNOno
2017-09-13 10:45:55 +08:00
confluence + 1
imherer
2017-09-13 10:46:18 +08:00
https://github.com/lord/slate 这个。支持搜索
codeyung
2017-09-13 10:47:41 +08:00
confluence 自写(之前项目都是自己 wiki 手写的 很多 ) 现在的 swagger 做模块服务时候用
fork3rt
2017-09-13 10:51:51 +08:00
swagger 或者 手写 markdown
liuqitoday
2017-09-13 11:20:08 +08:00
口口相传+1
YiBaZhuangYuan
2017-09-13 11:22:50 +08:00
GitLab

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

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

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

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

© 2021 V2EX