java 写的 web 服务, 要给前端提供接口文档, 问下大家都是怎么生成的?
现在业内实践用的都是啥?
现在业内实践用的都是啥?
|
alanhe421Mar 10, 2021
1
swagger
|
|
sunzirenMar 10, 2021
2
用过楼上的,挺好的
|
|
3
|
|
knightdfMar 10, 2021
4
openapi, swagger
|
|
wolfieMar 10, 2021
5
md 手写,生成的除了自己很难看,而且涉及到字段改动怎么标注。
|
|
lungankMar 10, 2021
6
swagger
|
|
rationa1cuzzMar 10, 2021
7
难道就我一个人手写吗?
|
|
hanssxMar 10, 2021
8
如果 python 的话,fastapi 很不错。
|
|
zlhsvcMar 10, 2021
9
手写,之前用过脚本总觉得差了点
|
|
yiqiaoMar 10, 2021
10
swagger 能够快速生成。
showdoc |
|
acmoreMar 10, 2021
11
swagger
Java 生态下也可以考虑 Spring Rest Docs |
|
balabalagugujiMar 10, 2021
12
可以用易文档编写 https://easydoc.xyz ,它也可以一键生成文档,也可以从注释生成文档。预览效果: https://www.easydoc.xyz/s/17790664
截图 https://i.loli.net/2021/03/10/jVQdKMkJ4FPevui.png |
|
liuzhaowei55Mar 10, 2021 via iPhone
13
手写
|
|
bigpigeonMar 10, 2021
14
swagger
|
|
bigpigeonMar 10, 2021
15
写了一个通过 go 框架生成 swagger 代码的 api,只要实现 api 就能自动生成 swagger
|
|
SjwNo1Mar 10, 2021
16
手写+1
|
|
cocowindMar 10, 2021
17
yapi docker 手写
|
|
jowanMar 10, 2021
18
swag
|
|
zhaorunzeMar 10, 2021
19
我还以为手写了个框架,仔细一想,可能是手写文档。。。
|
|
ghoulezttMar 10, 2021
20
swagger
|
|
MolitaMar 10, 2021
21
swagger 然后 用 redoc 展示
|
|
NoneUndefinedMar 10, 2021
22
swagger+插件直接变 doc
|
|
mcfogMar 10, 2021
23
重要的不是怎么生成,而是数据源在哪里,怎么管理
|
|
h82258652Mar 10, 2021
24
swagger,部分生成不了的用 docfx
|
|
oneendMar 10, 2021
25
只有我用 gitbook 吗?
|
|
www5070504Mar 10, 2021
26
swagger 只要增加几行注释 很好用..
|
|
a62527776aMar 10, 2021
27
apidoc
|
|
RekklesMar 10, 2021
28
yapi
|
|
29
|
|
journalistFromHKMar 10, 2021
30
上一家公司,老板写 java,啥是文档?不存在的,自己去看 controller 吧
|
|
so1nMar 10, 2021
31
自己写了一个库来自动生成 https://github.com/so1n/pait
|
|
henryhuMar 10, 2021
32
apidoc
|
|
KisekiRemiMar 10, 2021
34
对接的给我一个 swagger
|
|
cat007Mar 10, 2021
35
swagger+yapi
|
|
AngryPandaMar 10, 2021
36
md 手写 、YAPI
|
|
evamMar 10, 2021
37
postman 自己调试接口,然后 postman 分享,coding 自动生成
|
|
egfegdfrMar 10, 2021
38
smart-doc
感觉 swagger 的侵入性太强了 |
|
39
不喜欢 swagger 这种污染源码的工具,更喜欢用 yApi 这种类似的工具进行管理。
|
|
monkeyWieMar 10, 2021
41
swagger 然后自动同步到 yapi
|
|
scxiaziMar 10, 2021
42
restdoc
|
|
putaozhenhaochiMar 10, 2021
43
借楼问下,各位是先定义接口 还是先写代码
|
|
MarioLuoMar 10, 2021
44
YapiIdeaUploadPlugin IDEA 插件基于 JavaDoc 注释生成文档,上传到 yapi 中.
|
|
xnotepadMar 10, 2021
45
自己写了个 https://apidoc.tools
|
|
chogathMar 10, 2021
46
swagger + yapi,永远滴神
|
|
newmlpMar 10, 2021
47
md 手写
|
|
offswitchMar 10, 2021
48
@putaozhenhaochi 通常的说法是先写定义再写代码,不过大部分公司根本就没这要求,爱咋咋
|
|
alienx717Mar 10, 2021
49
md 手写
|
|
XCFOXMar 10, 2021
50
目前用过最舒服的是 GraphQL 。文档和接口无缝结合。接口还是强类型的。前端能直接根据 graphql 接口地址生成接口类型
|
|
20200924Mar 10, 2021
51
作为前端人员,感觉看 yapi 比看 swagger 舒服很多
|
|
justin2018Mar 10, 2021
52
每次 API 有啥修改 就发一份 word 文档
真是 不好吐槽 |
|
54xavierMar 10, 2021
53
swagger
|
|
sannyzengMar 10, 2021
54
yapi
|
|
fuyangyishi0Mar 10, 2021
55
没人用 RAP 吗
|
|
Gunn27Mar 10, 2021
56
|
|
guilingMar 10, 2021
57
yapi
|
|
qW7bo2FbzbC0Mar 10, 2021
58
因为 go 没有便捷的 swagger 工具,我转 spring 这种插件成熟的框架了
|
|
yang2048Mar 10, 2021
59
swagger 或者 knife4j
|
|
zhyd1997Mar 10, 2021
60
RESTful API,只有我用 Postman 写文档吗。。。
|
|
61
swag /:狗头
|
|
hakrMar 10, 2021
62
@YadongZhang #60 俺也用...
|
|
freebird1994Mar 10, 2021
63
swagger + yapi
|
|
nowtgMar 10, 2021
64
写 protobuf 然后生成 swagger
|
|
nowtgMar 10, 2021
65
使用 protobuf 定义,只要想改接口参数,proto 就必须修改,swagger 肯定也是最新的
|
|
ERRASYNCTYPEMar 10, 2021
66
实习生写
|
|
67
@ERRASYNCTYPE #66 铁子, nb
|
|
m1ch3ngMar 10, 2021
68
smart-doc,靠 javadoc 就能自动生成
|
|
liuzhihangMar 10, 2021
69
IDEA 插件 Doc View 纯 markdown 。不知道能不能满足你的需求。也欢迎 v2 小伙伴提 PR
https://github.com/liuzhihang/doc-view  |
|
CbdyMar 10, 2021 via Android
70
手写
|
|
liuzhihangMar 10, 2021
71
发不出来图…… 看链接吧 https://plugins.jetbrains.com/plugin/15305-doc-view
|
|
noyidoitMar 10, 2021
72
postman......
|
|
dcatflyMar 10, 2021
73
yapi 竟然有 1k+的 issue 没关闭,最近在用它内部的组件,代码写的一言难尽。。让我觉得这个项目还没死也是不容易。。
|
|
ArrayBufferMar 11, 2021
75
我是前端, 对我来说最好的还是 `swagger` / `graphql`; `swagger` 是比较成熟的, 但对于阅读者来说还是有些地方体验不是很好, 为此我写了个脚本 greasyfork.org/zh-CN/scripts/401581, `graphql` 我也写了 greasyfork.org/zh-CN/scripts/416677
|
|
xcatliuMar 11, 2021
76
Swagger UI 感觉不是很好看,有没有其他替代?(除了 yapi )
|
|
feitxueMar 11, 2021
77
swagger 增强 ui 后的 knife4j,会舒服一点.
|
|
zaulMar 11, 2021
78
语雀
|
|
balabalagugujiMar 11, 2021
79
@xcatliu #76 易文档可以看下,真好用
|
|
balabalagugujiMar 11, 2021
80
@vfxx #74 那肯定还没用过易文档
|
|
ccvipMar 11, 2021
81
我一直是用的 showdoc 私有化部署,易文档部署价格 8K,要不起。。。 易文档免费版竟然不支持导出
|
|
liuliangsirMar 18, 2021
82
@sss495088732 能问下,你用的是哪个 yapi docker 镜像
|
|
cocowindMar 18, 2021
83
|
|
84
smart-doc+torna,目前开源产品中国内最成熟的,科大讯飞和顺丰这些公司都在用,不是吹出来的。
|