Swagger-ui 锚链接到模型定义

问题描述 投票:0回答:2

是否可以直接通过锚点访问via swagger-ui的模型定义?

在示例页面http://petstore.swagger.io/我看到锚点适用于一组端点,例如 http://petstore.swagger.io/#/pet

将鼠标悬停在模型描述上会显示一个锚点(例如

#/definitions/Category
表示
Category
模型),但是 http://petstore.swagger.io/#/definitions/Category 没有把我带到那里。

如果我检查元素,我会看到锚点的真实链接

pet

<a class="nostyle" href="#/pet"><span>pet</span></a>

而对于

Category
,这是一个模型提示

<span class="model-hint">#/definitions/Category</span>

所以我想知道是否支持锚定模型..

javascript anchor swagger swagger-ui
2个回答
3
投票

Swagger UI 不支持模式/模型的永久链接。有一个现有的功能请求:
https://github.com/swagger-api/swagger-ui/issues/1369


0
投票

这可以通过内置的 HTML 机制来实现:

swagger 中的每个模型都在

div
内。这些
div
有一个 ID,其架构为
model-<ModelName
。将它们作为片段添加到您的 URL 中可以让您直接跳转到它们。以宠物店为例,这将是:https://petstore.swagger.io/#model-Category .

如果您想在 swagger 文档的

description
中嵌入链接以创建本地链接,您可以使用:
<a href="#model-<SchemaName>">schema</a>
,例如
<a href="#model-Category">schema</a>

© www.soinside.com 2019 - 2024. All rights reserved.