你们用什么写接口文档啊,我快被同事逼疯了

2019 年 10 月 30 日
 redam
他是这么写的
data: {
private ProductInfoVo productInfo
...
}

ProductInfoVo 对象:
{
private SalesInfo saleInfo
...
}

SalesInfo 对象:
{
...
}


然后这样一层层写下去,我看得要疯了
6510 次点击
所在节点    问与答
23 条回复
luman
2019 年 10 月 30 日
没看明白。。 直接 copy 实体到接口文档? 我一般用 apidoc
Vegetable
2019 年 10 月 30 日
啥玩意?代码当文档吗?能打过吗?
yeah2569
2019 年 10 月 30 日
不是一般用 markdown 么
redam
2019 年 10 月 30 日
@sunjiayao 前公司用小幺鸡,很舒服,现在有点难受
redam
2019 年 10 月 30 日
@Vegetable 啊,估计打不过→→,就吐槽一下,顺便问你们用什么写,商量一下看能不能改
kkkkkrua
2019 年 10 月 30 日
如果你是前端,让他给个响应 json 接口,后面加 //注释,不就好了。。
5yyy
2019 年 10 月 30 日
swagger
balabalaguguji
2019 年 10 月 30 日
文档+测试,现在市面最好用的:[https://easydoc.top]( https://easydoc.top)
chinvo
2019 年 10 月 30 日
swagger 请
Leigg
2019 年 10 月 30 日
@balabalaguguji 8 楼加一,超过三人每月五块
cluulzz
2019 年 10 月 30 日
swagger+1
Jacky23333
2019 年 10 月 30 日
yapi
v2dev
2019 年 10 月 31 日
yapi
letu86
2019 年 10 月 31 日
swagger 谁用谁知道
ebingtel
2019 年 10 月 31 日
换成 swagger 了
myon
2019 年 10 月 31 日
yapi
spring3shine
2019 年 10 月 31 日
swagger rap2
ibugeek
2019 年 10 月 31 日
eolinker,另外口口相传。
Tecrafter
2019 年 10 月 31 日
接口文档没人用 ShowDoc 吗?
energetic
2019 年 10 月 31 日
ShowDoc +1

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

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

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

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

© 2021 V2EX