ユーザーがネットワークリクエストを直接送るのではなくSDK経由でAPIを利用する場合は、x-codeSamples 拡張を使ってOpenAPIドキュメントにサンプルコードを追加し、OpenAPIページに表示できます。 このプロパティは任意のリクエストメソッドに追加でき、スキーマは次のとおりです。
lang
string
required
サンプルコードの言語。
label
string
サンプルのラベル。1つのエンドポイントに対して複数の例を提供する際に便利です。
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 });