根据Swagger/OpenAPI规范在Go中生成Swagger文档服务器

Question

我有一个OpenAPI规范，我使用了OpenAPI生成器来生成Golanggin服务器。

从OpenAPI规范生成Swagger documentation server的常规方法是什么？

我已经尝试过swag：它会在http://localhost:8080/swagger/index.html终点。但这需要在代码注释中描述API。我正在寻找一个来自OpenAPI规范的大摇大摆的UI生成器，我已经有了。

谢谢

Answer 1

有一个库将Swagger UI打包为Gohttp。处理程序：https://github.com/swaggest/swgui.

package main

import (
    "net/http"

    "github.com/swaggest/swgui/v3emb" // For go1.16 or later.
    // "github.com/swaggest/swgui/v3" // For go1.15 and below.
)

func main() {
    http.Handle("/", v3.NewHandler("My API", "/swagger.json", "/"))
    http.ListenAndServe(":8080", nil)
}

“/swagger.json”在本例中是指向OpenAPI规范文件的URL。

Answer 2

我对Gin不太确定，但我很高兴与大家分享我的解决方案（基于go server）：

1. 在项目根目录中创建一个名为./swagger-用户界面的目录
2. 在swagger-用户界面（https://github.com/swagger-api/swagger-ui/tree/master/dist）dist/*下复制文件
3. 在swagger-用户界面/index.html中将api规范的位置更新到url："/api/openapi.yaml"
4. 在main.go中创建一个新的变量，注释为//go： embed swagger-用户界面/*api/openapi.yaml（后者目录由openapi生成器CLI创建）
5. 在main.go中的（生成的）路由器下面添加：router. PathPrefix("/"). Handler（http. FileServer（http. FS（staticFiles））

就这样——你将在 /swagger-用户界面下提供斯瓦格UI，并从 /api/openapi.yaml自动加载api定义

golang prettyprint-override">package main

import (
    "context"
    ...
)

//go:embed swagger-ui/* api/openapi.yaml
var staticFiles embed.FS

func main() {
    router := ....

    // Embed the Swagger UI within Go binary
    router.PathPrefix("/").Handler(http.FileServer(http.FS(staticFiles)))

    ...

Answer 3

可以在docker容器中运行swagger editor。把它从https://hub.docker.com/r/swaggerapi/swagger-editor，运行它，将浏览器指向http://localhost:8080，然后加载api。yaml文件。您还可以运行swagger uihttps://hub.docker.com/r/swaggerapi/swagger-ui.