后端不写 api 文档怎么办, V 友们究竟是怎么解决的

2023-07-25 23:03:23 +08:00
 unt

后端只写 swagger,那玩意儿真的是狗都不看,为什么能设计得如此丑陋,有没有写得好的 swagger 让我看看,看是我们后端的问题还是这个工具的问题。

像下图这种文档只能手码吗,有工具吗

11249 次点击
所在节点    程序员
108 条回复
tudou527
2023-07-26 13:11:48 +08:00
当时做 oneapi.app 的一个原因就不想被这种事情卡住。只要后端的代码他们自己能看懂前端就能用
chf007
2023-07-26 13:24:34 +08:00
swagger 就够了呀,只是美丑的问题,又不是没有接口文档
lovelylain
2023-07-26 13:33:31 +08:00
proto 即文档,字段与功能一致,标清楚字段含义哪些必填哪些选填。想要单独的文档我是反对的,文档与接口定义分离的后果往往就是文档不及时更新,然后 OP 又要发帖,后端不及时更新 api 文档怎么办。
zhang77555
2023-07-26 13:34:44 +08:00
不用解决,有锅直接甩
huajia2005
2023-07-26 13:37:54 +08:00
swagger 这种感觉侵入性太强了,目前用的是 smrt-doc,通过注释生成 html 或者 swagger 以及 postman,都是 java doc 注释,没啥侵入性
https://github.com/smart-doc-group/smart-doc
miaotaizi
2023-07-26 13:40:20 +08:00
@unt 为公司考虑, 你是要笑死我, 然后公司把你开了
skiy
2023-07-26 13:43:24 +08:00
rap2.taobao.org BUG 虽然多了点,但勉强能用。数据要动态扩展的另说。
wanniwa
2023-07-26 13:44:17 +08:00
可以让后端接一下这个 https://doc.xiaominfo.com/ ,swagger 的一个新的 ui
th00000
2023-07-26 14:00:08 +08:00
"Swagger 狗都不看",你再骂!
irrigate2554
2023-07-26 14:52:25 +08:00
虽然不说精通,前端也稍微懂点后端吧,后端也稍微懂点前端吧,像我们这边接口文档一般用 swagger 的 json 导入到 apifox 给前端,有时候前端着急都直接去看看 Controller 就完了,有时候后端接口有小的改动也可以前端代码里面一搜索一起改了就好了,人人都只管自己端的东西,然后要求对方给完美的交付物的话那中间连接这块就是事多。
1044523901
2023-07-26 17:06:58 +08:00
"Swagger 狗都不看",再骂!
aino
2023-07-26 17:08:52 +08:00
直接后端代码丢给前端去对接,代码就是最好的接口文档😆
xiaoHuaJia
2023-07-26 17:16:30 +08:00
swagger 文档都给了,稍微在问一下沟通一下,互相包含以下的事情,还在这里抱怨,那只能后端都学一下前端,直接挤掉前端岗位,前端学后端直接挤掉后端岗位,无沟通成本。开卷
daimubai
2023-07-26 18:07:43 +08:00
连个 swagger 都看不明白吗。。。
sampeng
2023-07-26 18:09:07 +08:00
@unt 那不是 swagger 的问题。。是人的问题。找后端 leader 说,这样不行。要改。我见过很多后端图省事把数据库直接反回来,前端自己挑自己用的。。然后零注释
xiaowei7777
2023-07-26 18:15:28 +08:00
swagger 都没得你见过吗?
yrzs
2023-07-26 18:29:37 +08:00
作为后端 我直接生成 ts 包,连所有的 interface 每个字段都有注释,直接调用就完事。
Rehtt
2023-07-26 19:04:16 +08:00
生成 swagger 拖到 yapi 就好了
PendingOni
2023-07-26 19:12:59 +08:00
记得之前项目接口文档都是在 ApiFox 上谁开发的接口谁写文档 与其和 swagger 这种工具死磕不如换一种管理思路
tairan2006
2023-07-26 19:58:15 +08:00
我不爱用 swagger ,而且我一般是先写文档后开发的。不然让前端等接口?

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

https://ex.noerr.eu.org/t/959713

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

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

© 2021 V2EX