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

[unt]

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

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

[CQdake]

这个请求参数我感觉挺清晰的啊，有啥不明白？可能是这个接口比较简单？

[Jinnn]

有 swagger 了就好办，我在前端项目定期抓 swagger 生成的配置文件，把接口入参和返回转换为 ts 类型定义，写项目很舒服了

[hansomeneil]

@owen800q #1 真要是忙到不写文档，或者压根没有写文档的硬要求，那他给你元数据让你自己生成 api 文档，那也不敢用啊。。。太不稳定了，他改你也得改

[hansomeneil]

@owen800q #1 这问题太大了，肯定要说道说道的

[unt]

@buffzty #59 这也是个办法，这个就叫做“协同”，只不过是共享的一个账号而已

[lxy]

editor.swagger.io 各种注释 swagger 示例都可以做到，只是后端不愿意写罢了，我估计他只加了注解，其它什么也没写。

[happy321]

我们前端也会自己写接口，就是他也不提供文档了

[iseki]

swagger 是个工具，文档规范新的现在叫 OpenAPI ，一般说 swagger 文档都是这个，工具你可以自己选

[EvaCcino]

前后端直接改用 Protobuf

[vHypnos]

有 swagger 的话，我觉得不能说没有文档，还有比 swagger 更好用的吗

[xudaxian520bsz]

额，RunnerGo 才是解决方案

[ghost024]

我们组是如果不写接口文档的话，前端直接就开操了，所以所有人对接的时候，先出文档，再说对接的事情，而且请求参数和返回参数分有必须参数和非必须参数两种，反正开发之前，先写文档都得一天多。。。。。（然后如果接口改了，还得同步去改文档）

[afutureus]

用的 Apifox ...

[AmaQuinton]

1. 如果给外部调用，给其他公司使用，都会写接口文档，加测试示例
2. 如果公司同事提供，那就先 postman 调试没有问题，导出后发出，有问题再沟通就行

[dif]

swagger 有个好处是会实时更新，word/markdown 文档需要依赖人工更新得，闲的时候还行，改一个接口同步一下文档，忙的时候就顾不上了，久而久之，文档与代码基本上落下好几个版本。
没有完美的解决方案，前后端多沟通吧

[leichnX]

转行做全栈，自己负责的功能，前后端都自己上，不扯皮，接口爱咋定义就怎么来，爱咋写咋写（前提是能过代码审查）

[mcluyu]

笑死了，评论区一堆连接口文档都写不明白甚至不写懒得写的还好意思出来现眼。。。屎山不就是这样堆出来的，注释没有，文档没有。。。 说人代码屎山的和自己疯狂堆屎的往往是一批人

[wangritian]

swagger 不是用来看的，是用来自动生成 sdk 的
对接过 go java python react ，他们的 sdk 都是我写工具生成的
接口函数，输入输出对象，和所有的注释全都有

[sdjl]

后端不写文档的原因只有一个：“我凭啥给你？”

[iosyyy]

你让后端用 apifox 做测试 自动就会有个文档了