一个想法：通过中间层代理来解析 API 输入/输出，自动生成 swagger 文档

2022 年 8 月 22 日
 page470075640
代理目标是 API test code ，想知道有现成的这类工具吗？如果没有我就打算尝试一下。。。
2691 次点击
所在节点    奇思妙想
10 条回复
minibear2021
2022 年 8 月 22 日
感觉意义不大，一般不是应该文档先行吗？
luvroot
2022 年 8 月 22 日
grpc reflect 现在就支持
xaplux
2022 年 8 月 22 日
接口描述，参数描述等获取不到吧，感觉这个还是比较重要的
page470075640
2022 年 8 月 22 日
@jstony 不同的开发方式吧。。。我这边都是写完测试代码后才开始写文档的

@luvroot 能贴一下项目链接吗？

@xaplux 参数描述确实是个问题，目前的想法是通过变量的语义和错误信息来说明这个问题。
luvroot
2022 年 8 月 22 日
@page470075640 https://pkg.go.dev/google.golang.org/protobuf/reflect/protoreflect 其他语言的应该也有对应的实现
wdwwtzy
2022 年 8 月 22 日
不太明白，写注释的时候，不就是写好了 swagger 文档吗？是其他语言不行吗？.net 就是注释就是 swagger 文档
luvroot
2022 年 8 月 22 日
一般都是通过写注释写好了 由工具生成 swagger json 。
还有一种完全不写注释，比如 grpc 的这种通过 reflect 找到接口名字和参数，只提供接口名和参数展示
page470075640
2022 年 8 月 22 日
结贴：通过注释或者 grpc 能自动生成 swagger ，谢谢各位答疑解惑
kkeep
2022 年 8 月 22 日
已经有了
ternice
2022 年 8 月 23 日
swagger 感觉只适合 个人开发或者独立开发
实际项目 接口设计和接口实现就不是一个人，都是先有文档才有接口

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

https://study.congcong.us/t/874587

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

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

© 2021 V2EX