swagger-ui - Hugo Docsy SwaggerUI 短代码不呈现规格文件
问题描述
我正在尝试使用Hugo Docsy SwaggerUI Shortcode呈现 OAS 文件,但呈现的页面不包含预期的结果。
这是我的rest-api.md
文件:
---
title: "REST API"
linkTitle: "REST API"
date: 2021-02-21
weight: 2
description: >
REST API described using OpenAPI Specification.
---
{{< swaggerui src="http://localhost:1313/access.yaml" >}}
这是渲染的页面:
如您所见,HTML 包含以下尝试呈现 OAS 文件的脚本:
var resolveUrl = function () {
var passedUrl = 'http:\/\/localhost:1313\/access.yaml';
var baseUrl = '\/\/localhost:1313\/'.replace(/\/$/, '');
if (passedUrl.startsWith('/')) {
return baseUrl + passedUrl;
}
return passedUrl;
};
window.onload = function () {
const ui = SwaggerUIBundle({
url: resolveUrl(),
dom_id: '#ohpen_swagger_ui',
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
]
});
window.ui = ui;
};
需要注意的是,http://localhost:1313/access.yaml
成功解析到access.yaml
文件。
是什么阻止了 OAS 文件被呈现?
解决方案
我发现了我的错误。type
必须在页面的前端设置为swagger
。
页面必须如下:
---
title: "REST API"
linkTitle: "REST API"
type: swagger
date: 2021-02-21
weight: 2
description: >
REST API described using OpenAPI Specification.
---
{{< swaggerui src="http://localhost:1313/access.yaml" >}}
/access.yaml
如果Hugo 将 OAS 文件作为静态文件提供,则可以使用相对路径引用 OAS文件。
推荐阅读
- ios - 是否可以关闭 QLPreviewController 上的复制文本
- python - 去掉括号
- pytorch - 尝试构建支持旧 gpu (3.0) 的 pytorch 1.0.0 cuda 10.2
- bash - 无法访问 bash 脚本函数中的配置文件变量
- javascript - NestJS (NodeJS) client.query 运行 3 次,结果为空
- mongodb - MongoDB - 过滤数组并获取不同的计数
- python - 如何根据熊猫列注释散点图中的点?
- javascript - 简单JS函数的解决方案
- c# - 为什么字符串哈希在 C# 和 SQL Server 中会产生不同的结果?
- flutter - 转换 listview -> listview.builder