在Redoc侧边菜单中有模式

Question

Redoc是一个很棒的工具，但我很难理解它是如何工作的。目前，我的任务是从api-docs.io复制一些文档，以便使用redoc进行自助服务。

但是，我的问题是模式不会像在api-docs站点上那样出现在侧边栏中。我不知道怎样才能让模特也在旁边展示……而且我对api文档还是个新手。您还可以查看模型是如何在here中显示的。请看下面的另一个例子。

​

​

我看了看这是否是redoc的一个特性，偶然发现了this merged PR (基于PR问题中的讨论)，它指出我们应该添加一个html元素SchemaDefinition。我使用的是基本的html文件(在redoc repo的自述文件中建议)，但我们希望使用json模式(通过spec-url引用)来呈现redoc上的文档，所以我正在努力理解如何仅使用html元素来操作侧边栏。

也许这仅仅是我对redoc如何工作的理解的缺失。如果你觉得是这样的话，一个快速的解释将是很棒的。

Answer 1

您必须使用附加信息修改json。

示例json (没有侧栏模型部分)：https://petstore3.swagger.io/api/v3/openapi.json

添加到“tag”数组

{
  "name": "pet_model",
  "description": <SchemaDefinition schemaRef="#/components/schemas/Pet" />,
  "x-displayName": "Pet"
},
{
  "name": "user_model",  
  "description": <SchemaDefinition schemaRef="#/components/schemas/User" />,
  "x-displayName": "User"
}

然后，要对侧栏进行分组，请添加x-tagGroups扩展

...
"tags": [...],

"x-tagGroups": [{
  "name": "Api",
  "tags": ["pet", "store", "user"]
},
{
  "name": "Models",
  "tags": ["pet_model", "user_model"]
}],

"paths": ...