Swagger UI 无法加载规范时，如何通过预生成链接支持多个 API 规范

在IT行业这个发展更新速度很快的行业，只有不停止的学习，才不会被行业所淘汰。如果你是Golang学习者，那么本文《Swagger UI 无法加载规范时，如何通过预生成链接支持多个 API 规范》就很适合你！本篇内容主要包括##content_title##，希望对大家的知识积累有所帮助，助力实战开发！

我有一个用 go 编写的服务，它也使用 go 模板作为前端。我们的外部第三方使用该服务作为查找内容和搜索的门户。还有另一个服务是用于处理订单的 rest api。门户服务有一个页面，您可以在其中查找 api 文档。 我只有一个 api 版本，并且使用 swaggerui 来显示 api 文档。我必须创建一个新端点并使其成为新 api 版本的一部分。现在我想展示一个新的 api 版本，同时也展示用于支持旧客户端的旧版本。像这样的东西：

因此，当用户单击门户网站上的按钮查看文档时，请求将由门户中的此函数处理（注意：我已经重构了此函数以支持多个 url）：

func getdocs(c echo.context) error {
    source := c.get(auth.sourcename).(string)
    key := c.get(auth.keyname).(string)

    jsonurls := []docsurl{
        {
            url:         fmt.sprintf("%s/0.1/docs?source=%s", config.baseurl, key),
            name:        "0.1"
        },
        {
            url:         fmt.sprintf("%s/1.0/docs?source=%s", config.baseurl, key),
            name:        "0.1"
        },
    }

    return c.render(http.statusok, "docs/index", map[string]interface{}{
        "source":   source,
        "key":      key,
        "pagetype": "docs",
        "jsonurls": jsonurls,
    })
}

这是我使用 swaggerui 的模板中的脚本：

  window.onload = function() {
    const ui = swaggeruibundle({
      urls: {{ .jsonurls }},
      dom_id: '#swagger-ui',
      deeplinking: true,
      presets: [
        swaggeruibundle.presets.apis,
        swaggeruistandalonepreset
      ],
      plugins: [
        swaggeruibundle.plugins.downloadurl
      ],
      layout: "standalonelayout",
      supportedsubmitmethods: []
    })
    window.ui = ui
    $('.tryitout').prop('disabled', true);
  }

我需要根据环境（生产、暂存、本地）生成链接。在后端生成数据并将其提供给模板进行显示也是有意义的。但这行不通！

但是，如果我对 swaggeruibundle 中的链接进行硬编码，它就会起作用，并且门户会显示正确的下拉菜单，并允许在版本之间切换并加载相应版本的文档。

func getdocs(c echo.context) error {
    source := c.get(auth.sourcename).(string)
    key := c.get(auth.keyname).(string)

    return c.render(http.statusok, "docs/index", map[string]interface{}{
        "source":   source,
        "key":      key,
        "pagetype": "docs",
    })
}

在模板中：

window.onload = function() {
    const ui = SwaggerUIBundle({
      urls: [
        {
          url: "http://localhost:8088/0.1/docs?source=111111",
          name: "0.1"
        },
        {
          url: "http://localhost:8088/1.0/docs?source=111111",
          name: "1.0"
        }
      ],
      dom_id: '#swagger-ui',
      deepLinking: true,
      presets: [
        SwaggerUIBundle.presets.apis,
        SwaggerUIStandalonePreset
      ],
      plugins: [
        SwaggerUIBundle.plugins.DownloadUrl
      ],
      layout: "StandaloneLayout",
      supportedSubmitMethods: []
    })
    window.ui = ui
    $('.tryitout').prop('disabled', true);
  }

这是为什么呢？有没有办法让第一个版本的代码工作？

我需要链接是动态的，并且最好在处理程序中生成。谢谢！

解决方案

似乎有两个错误：

第一：

urls: {{ .jsonurls }},

这不会为您编写 json 格式的 jsonurls。它只会写入 jsonurls 的字符串表示形式。您需要编写模板来迭代 jsonurls 的元素并将它们一一打印出来，或者自己将 jsonurls 编组为 json：

jsontext,_:=json.marshal(jsonurls)
return c.render(http.statusok, "docs/index", map[string]interface{}{
        "source":   source,
        "key":      key,
        "pagetype": "docs",
        "jsonurls": string(jsontext),
    })

第二：看起来您没有导出 docsurl 结构的成员字段。将字段名称大写并添加 json 标签。

type DocsURL struct {
  URL string `json:"url"`
  Name string `json:"name"`
}

终于介绍完啦！小伙伴们，这篇关于《Swagger UI 无法加载规范时，如何通过预生成链接支持多个 API 规范》的介绍应该让你收获多多了吧！欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布Golang相关知识，快来关注吧！