从gin项目生成OpenAPI规范

Question

有办法从gin项目生成OpenAPI规范文件吗？这个问题真的很难找到，到目前为止，我所能找到的都是做反向的。

Answer 1

杜松子酒正在从您的代码中提取注释。

运行swag init会生成：

• docs.go:提供SwaggerUI页面
• swagger.json: json文件格式的Swagger规范。
• swagger.yaml: yaml文件格式的Swagger规范。

Answer 2

你是说API用户的API文档吗？

我看到你用swagger标记这个问题。

你有两个选择：

1. 昂首阔步

这个包包含Swagger2.0(又名OpenAPI 2.0 )的一个很好的实现:它知道如何序列化和反序列化Swagger规范。

1. 拭子

将Go注释转换为SwaggerDocuments2.0。我们为流行的Go web框架创建了各种插件。这允许您快速地与现有的Go项目集成(使用Swagger )。

他们之间有什么区别？

以下是来自昂首阔步的答案

现在最主要的区别是这个确实有效..。 swagger-codegen项目(如swag)只生成一个可行的go客户端，即使在那里，它也只支持平面模型。此外，由swagger-codegen生成的go服务器主要是存根。

这个答案的细节在这与自行其是的go生成器有什么不同？中来自昂首阔步。