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

@EchoAI #20 是的是的，你完全懂我。我想要的是 0 沟通，全靠文档对接。现在沟通成本太高了

@EchoAI #20 而且我们这边对于嵌套对象的注释也没有，只有第一层对象属性的注释

sw 看起来确实费劲，我都是导到 yapi 里

我前后端自己写，没这些烦恼。你的图片看不到啊 萤石接口.png

你倒是给我们看看怎么个丑陋法啊

swagger 能不能看全看后端用不用心，有的别说注释了，参数都写不全，还有文档写 query 传数组的。这时候过去跟后端儒雅随和一番是最有效的解决方法。

最恶心的是，有文档了，字段没有注释...

那是你们后端 swagger 注解写的不规范，直接骂他就行了，这个锅 swagger 可不能背。

楼主的图，微博图床现在又不能直接访问了？
https://i0.wp.com/tva1.sinaimg.cn/large/aa9984degy1hg9jpuq94oj20wi17s447.jpg

作为一个后端，说真的确实不愿意专门去写文档，如果非要提供文档，我会想办法自动化生成 md 然后再转成 word 或 html 提交。

但是，无论使用 swagger 还是 postman ，最少得有一个地方能有完整的，随时更新且应该尽可能正确带有详细注释的接口说明。

至于好不好看，老子才不管呢，又不是不能用。你不是前端嘛，嫌不好看可以自己调样式啊。

所以，个人结论：后端提供文档字段方面的不完整，必须后端给。

至于界面不好看，能看就行，不行自己改。

至于不好使，这个问题应该前后端沟通，选择对双方都好的，或者是能相互转换的。

就算是 swagger 不好用，也不是你前端赖后端的原因，逼事真多，前端普片的菜和有问题赖后端

评论区后端集体破防

直接用 apifox 、yapi 等工具自行导入，swagger 有提供 json 链接的，设置自动同步，不知道多香，apifox 还有 ts 类型生成

自己去看 pb

我们都是手撸 swagger

https://github.com/TangSengDaoDao/TangSengDaoDaoServer/tree/main/assets/swagger

我们开源的商用级别的即时通讯软件

redoc demo: https://redocly.github.io/redoc/
Docker Engine API: https://docs.docker.com/engine/api/v1.43/

swagger 的 yaml 可以导入 apifox 、postman 。

swagger 也是文档，你可以说它丑，但是说没给文档就过分了，颠倒黑白

普通的系统全员全栈才是正解，沟通成本太高了

我认为 swagger 的丑不只是说界面丑，而是很多地方不够好用，并且污染 controller ，例如不能很好的处理响应有成功、失败，成功情况 1 的响应结构，成功情况 2 的响应结构 (很多人的接口就这么干)，对结构里特殊字段的描述，响应示例等。