swagger ui 排序
时间: 2023-07-25 14:32:17 浏览: 85
在 Swagger UI 中,可以使用 `tags` 属性来对 API 操作进行分组,并按照指定的顺序进行排序。`tags` 属性应该是一个数组,其中每个元素都是一个包含 `name` 和 `description` 属性的对象。例如:
```yaml
tags:
- name: pets
description: Everything about your Pets
- name: users
description: Operations about user
```
在这个示例中,我们定义了两个标签:`pets` 和 `users`。`name` 属性用于指定标签名称,`description` 属性用于指定标签描述。
如果需要对标签进行排序,可以在每个标签对象中添加一个 `order` 属性,例如:
```yaml
tags:
- name: pets
description: Everything about your Pets
order: 2
- name: users
description: Operations about user
order: 1
```
在这个示例中,我们为 `pets` 标签指定了 `order: 2`,为 `users` 标签指定了 `order: 1`。这样,在 Swagger UI 中,`users` 标签将会排在 `pets` 标签前面。
需要注意的是,如果某个 API 操作没有被分组到任何标签中,那么它将会被放在默认的 `default` 标签中。可以通过在 `tags` 属性中指定一个 `name: default` 的标签来自定义默认标签的名称和描述。例如:
```yaml
tags:
- name: default
description: Miscellaneous operations
```
在这个示例中,我们自定义了默认标签的名称和描述。如果某个 API 操作没有被分组到任何标签中,那么它将会被放在 `default` 标签中。