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

公司准备使用 swagger，基于注解的方式，但是发现多个项目无法集成，很不方便
swagger-ui 中没有接口的搜索功能

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

gy911201

2017-09-12 23:13:16 +08:00

口口相传

fbzl

2017-09-13 00:15:48 +08:00

口口相传，心灵感应

lgh

2017-09-13 00:28:47 +08:00

@orancho #12 顺便问个相关的问题：pb 只能体现接口报文格式，你们是怎样管理 pb 和实际接口之间的关联关系这些信息的？

Jackeriss

2017-09-13 01:02:57 +08:00

这个全看悟性

junbguistar

2017-09-13 01:12:15 +08:00

接口多就自己搭 wiki 和 swagger 少就口口相传

49degree

2017-09-13 01:13:42 +08:00

RAP

fan123199

2017-09-13 01:14:59 +08:00

word 文档

Lucups

2017-09-13 01:19:33 +08:00

不同方式的文档都有各自的优劣和使用场景，我主要考虑沟通成本，哪种方式沟通成本小用哪种。
目前在公司用 confluence 手写，一个接口一个页面，其他部门人来要时直接丢链接。

PS：Swagger 默认的 UI 不是很好用。有同感的可以考虑这个项目 https://github.com/jensoleg/swagger-ui。

Lucups

2017-09-13 01:20:18 +08:00

我晕，加了空格还是把句号和链接合在一起了。。。重新补一下:

https://github.com/jensoleg/swagger-ui

Tyrion

2017-09-13 02:12:31 +08:00

confluence + 1

bombless

2017-09-13 02:24:17 +08:00

写代码注释里面的，靠自觉，很多人不写的。

听说大公司都是靠口口相传

feiyuanqiu

2017-09-13 03:18:32 +08:00

@Lucups 我最近刚好在改这个 ui。它有个问题是把接口参数放在 div 的属性里，导致没法选择及复制，而且参数名长一点的话就显示不全。另外我也不太喜欢它调用接口时单独弹出一个 modal 的方式

msg7086

2017-09-13 07:33:02 +08:00

早已失传……

motai

2017-09-13 08:13:53 +08:00

rap，word，内部的 wiki 系统

xtaxcy

2017-09-13 08:18:46 +08:00

小幺鸡

caijihui11

2017-09-13 08:37:49 +08:00

apidoc

NSAtools

2017-09-13 08:39:03 +08:00

口口相传

icycai

2017-09-13 08:53:06 +08:00

口口相传+1

kindjeff

2017-09-13 08:57:43 +08:00

传嫡不传庶，传长不传幼，传男不传女

justicelove

2017-09-13 09:01:48 +08:00

搜索就是 control + F

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

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

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

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