标签显示名称

默认情况下，OpenAPI 规范中的标签名称会成为 API Reference 中的章节名称。使用 x-displayName 扩展来控制这些章节名称在生成的文档中的显示方式。这有助于控制大小写和创建用户友好的名称。

在 OpenAPI 规范的根级别定义带有显示名称的标签，然后在操作中按名称引用它们：

openapi.yml

1 openapi: 3.0.0
2 info:
3   title: Plant Care API
4   version: 1.0.0
5 
6 tags:
7   - name: plant
8     x-displayName: Plants
9     description: Operations for managing plants
10   - name: watering-schedule
11     x-displayName: Watering Schedules
12     description: Handle watering schedule operations
13 
14 paths:
15   /plants:
16     get:
17       tags:
18         - plant
19       summary: List all plants
20   /plants/{plantId}:
21     get:
22       tags:
23         - plant
24       summary: Get a plant by ID
25   /watering-schedules:
26     get:
27       tags:
28         - watering-schedule
29       summary: List watering schedules

您还可以在覆盖文件中设置显示名称。

或者，您也可以直接在docs.yml 文件中重命名章节。

1	openapi: 3.0.0
2	info:
3	title: Plant Care API
4	version: 1.0.0
5
6	tags:
7	- name: plant
8	x-displayName: Plants
9	description: Operations for managing plants
10	- name: watering-schedule
11	x-displayName: Watering Schedules
12	description: Handle watering schedule operations
13
14	paths:
15	/plants:
16	get:
17	tags:
18	- plant
19	summary: List all plants
20	/plants/{plantId}:
21	get:
22	tags:
23	- plant
24	summary: Get a plant by ID
25	/watering-schedules:
26	get:
27	tags:
28	- watering-schedule
29	summary: List watering schedules