将Swagger与现有API集成

Question

有没有办法自动生成文档和客户端UI以与我已创建的现有Go服务进行交互？

我对自动生成的API服务代码的唯一问题是因为我有两种类型的支持传输（gRPC和http）。我不想局限于自动生成的Swagger服务器。

Answer 1

一旦您的 HTTP 服务实现与收集文档的工具兼容，这便成为可能。

例如，您可以在代码中添加魔术注释并使用 https://goswagger.io/generate/spec.html。

或者，您可以重构 http 处理程序和路由器设置以匹配 https://github.com/swaggest/rest 的约定并反映规范。