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

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

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

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

11249 次点击
所在节点    程序员
108 条回复
oppoic
2023-07-26 09:54:52 +08:00
楼主的图,你这是 swagger ?


花里胡哨随着时间推移都废弃了,还是 swagger 这种能实时读取的能持久下去。看不懂让后端好好学学,swagger 非常灵活

最后,V 站传图的正确姿势: https://ex.noerr.eu.org/t/846267
unt
2023-07-26 09:58:30 +08:00
@uni #39 对,是的,我现在很多接口自己写了,沟通成本太高了。自己写要快得多
theyzw
2023-07-26 10:01:39 +08:00
swagger 的 ui 不好看是真的,换个皮用 knife4j
keppelfei
2023-07-26 10:20:12 +08:00
你应该问,后端不写注释或者更靠谱,openai 有的是靠注释、注解来生成 swagger 的
Stop
2023-07-26 10:21:40 +08:00
自己看代码,自己改后端
wizzer
2023-07-26 10:23:11 +08:00
swagger 的界面可以自己改改嘛,比如我改的:

https://demo.budwk.com/api/openapi/#/load/openapi.json
TingFengShuo
2023-07-26 10:25:48 +08:00
都给你写 swagger 了知足吧
nerkeler
2023-07-26 10:44:56 +08:00
我还以为没给接口文档呢,文档描述不清楚可以找后端描述清楚,文档不好看?基础的样式就是最好的选择,花里胡哨的,你喜欢万一其他人嫌弃呢?还狗都不看。我遇到的前端都是想把问题抛给后端,一个入参格式转换都不想做。
unt
2023-07-26 10:45:14 +08:00
@TingFengShuo #47 文档属于公司资产啊,我为公司考虑,我自己手里是有适合自己的文档( insomnia )的
StateMa
2023-07-26 10:55:10 +08:00
看见没 头顶就有个魔幻生物哎,op 说了后端文档不清晰,接口调试时间成本高,到你嘴里就成菜了?

我感觉能力不是主要问题,傲慢才是。

合着把自己的本职工作甩出去包装成能力不足就是本事强啊?张口一个抛开事实不谈味太冲了,下次发表前记着看看回复框右下角的字。


@aogg
cooper
2023-07-26 11:03:20 +08:00
我们之前是前端定义接口。 先定义,mock ,最后对接。
me1onsoda
2023-07-26 11:16:02 +08:00
@StateMa 你才是魔幻生物吧? op 是正文还是标题体现了你说的“op 说了后端文档不清晰,接口调试时间成本高”?自己刚开始说的嫌弃丑陋,说着说着又变成文档不清晰。op 自己这表达能力嫌弃别人文档不清晰也是挺乐的
version
2023-07-26 11:20:42 +08:00
swagger 如果服务端注释生成的..那可读性是很差的.基本和没文档差不多..
提供的模型定义基本没啥用.crud 的接口可能服务端自己都没测试过..

还有就是 业务需求..后端自己都不提供模拟数据参数.只顾说文档和接口已经提供.自己摸索
当前端辛苦查看文档.模拟出数据插入的时候..发现报错了..问后端..后端答复是查看下日志..是 bug.改了.等几分钟部署再试试.

目前大部分现状就是这样...别问我怎么知道的.我遇到的很多 java 老都这样..所以我害怕和 java 对接.

最后我不是前端..我是后端..我不想成为上面说的那种人.都会提供字段文档+postman+业务页面案例假数据
fantathat
2023-07-26 11:27:10 +08:00
替后端说两句,swagger 本身没问题,问题是后端没有按照 restful 和 swagger 规范来,就是一个大 json ,出了问题找不到人,没有人来配合前端。我去,怎么感觉是在替 swagger 说了两句
zqguo
2023-07-26 11:27:55 +08:00
这个要向上反馈,像我们后端在 ERD 评审完成之后就需要进行接口设计,设计好之后和前端做接口评审,接口编写有一个专门编写的平台,这个流程要集成到项目流程规范,有流程、规范这个事就好执行了。
zqguo
2023-07-26 11:29:51 +08:00
评论区戾气太重,互相攻击意义在哪里,把问题暴露出来,想办法怎么解决,更好的协同不都是为了大家工作舒服些,减少点沟通成本?
barbery
2023-07-26 11:33:06 +08:00
我们用的是 graphql ,可以自动生成文档,字段类型和注释都有说明
LeonardSc
2023-07-26 11:35:59 +08:00
向上反馈
buffzty
2023-07-26 11:40:03 +08:00
我是直接共享一个 postman 账号出去,所有人都在里面看,postman 请求数据可以注释 比文档方便多了
StateMa
2023-07-26 11:46:17 +08:00
@me1onsoda 合着后面的补充不是 op 是吧,那后面 op 说的选择性无视?

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

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

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

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

© 2021 V2EX