标签显示名称 (OpenAPI) | Fern Documentation

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

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

openapi.yml

openapi: 3.0.0
info:
  title: Plant Care API
  version: 1.0.0
tags:
  - name: plant
    x-displayName: Plants
    description: Operations for managing plants
  - name: watering-schedule
    x-displayName: Watering Schedules
    description: Handle watering schedule operations
paths:
  /plants:
    get:
      tags:
        - plant
      summary: List all plants
  /plants/{plantId}:
    get:
      tags:
        - plant
      summary: Get a plant by ID
  /watering-schedules:
    get:
      tags:
        - watering-schedule
      summary: List watering schedules

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

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