Swagger UI是否有永久链接路径?

时间:2017-07-17 15:19:16

标签: swagger-ui

是否可以链接到Swagger UI中显示的特定路径,例如下面图片中的/work/2.1

This is my swagger ui relative path

我想从外部网页链接到各个路径。

1 个答案:

答案 0 :(得分:1)

是的,Swagger UI的操作和标签有permalinks。要获得永久链接,请展开操作或标记并在地址栏中复制URL。永久链接看起来像这样:

index.html#/tagName
index.html#/tagName/operationId

当有人在浏览器中打开这样的永久链接时,相应的标记或操作会自动展开,并且如果需要也会滚动到顶部。例如:
http://petstore.swagger.io/#/store/getInventory


在Swagger UI 2.2中,默认情况下启用永久链接。

如果您使用的是UI 3.x,则需要3.0.19或更高版本,并且需要将deepLinking: true添加到index.html中的Swagger UI初始化代码中:

const ui = SwaggerUIBundle({
  url: "http://petstore.swagger.io/v2/swagger.json",
  deepLinking: true,  // <------