如果你的用户通过 SDK 与 API 交互,而不是直接发起网络请求,你可以使用 x-codeSamples 扩展将代码示例添加到 OpenAPI 文档中,并在 OpenAPI 页面显示。 该属性可添加到任意请求方法,且遵循以下结构。
lang
string
required
代码示例所用的语言。
label
string
示例的标签。为单个端点提供多个示例时很实用。
source
string
required
示例的源代码。
下面是一个植物追踪应用的代码示例,它同时提供 Bash CLI 工具和 JavaScript SDK。
paths:
  /plants:
    get:
      # ...
      x-codeSamples:
        - lang: bash
          label: List all unwatered plants
          source: |
            planter list -u
        - lang: javascript
          label: List all unwatered plants
          source: |
            const planter = require('planter');
            planter.list({ unwatered: true });
        - lang: bash
          label: List all potted plants
          source: |
            planter list -p
        - lang: javascript
          label: List all potted plants
          source: |
            const planter = require('planter');
            planter.list({ potted: true });