如何将swagger ui嵌入网页?

Aka*_*sam 15 api swagger swagger-ui

如何将swagger-ui嵌入到网页中.基本上我想要一个API端点测试环境嵌入到我的网页中.

Hel*_*len 32

答案取决于您是否拥有直接编辑的纯网页,或使用Node.js或React等框架.为简单起见,我将假设前者.

下载(或克隆)Swagger UI存储库.您需要该文件dist夹中的以下文件:

swagger-ui.css
swagger-ui-bundle.js
swagger-ui-standalone-preset.js
Run Code Online (Sandbox Code Playgroud)

<head>网页的部分中,添加:

<link rel="stylesheet" type="text/css" href="swagger-ui.css">
Run Code Online (Sandbox Code Playgroud)

在里面<body>,添加:

<div id="swagger-ui"></div>

<script src="swagger-ui-bundle.js"></script>
<script src="swagger-ui-standalone-preset.js"></script>

<script>
window.onload = function() {
  const ui = SwaggerUIBundle({
    url: "https://yourserver.com/path/to/swagger.json",
    dom_id: '#swagger-ui',
    presets: [
      SwaggerUIBundle.presets.apis,
      SwaggerUIStandalonePreset
    ]
  })

  window.ui = ui
}
</script>
Run Code Online (Sandbox Code Playgroud)

<div id="swagger-ui"></div>是将在其中呈现Swagger UI的DOM节点.该SwaggerUIBundle构造函数初始化扬鞭UI.您可以在此处指定规范URL和其他参数.