カスタムコードサンプルの追加

APIエンドポイントと一緒に表示するカスタムコードサンプルを設定する方法を学びます

GitBook は、各 API 操作に対して一般的なコード例を自動生成できます。カスタムまたはより詳細なスニペットを表示したい場合は、追加してください x-codeSamples OpenAPI 定義に。これにより、エンドポイントのデモ方法を制御でき、言語や SDK 固有の例を提供できます。

openapi.yaml

paths:
  /users:
    get:
      summary: ユーザーを取得
      x-codeSamples:
        - lang: JavaScript
          label: Node SDK
          source: |
            import { createAPIClient } from 'my-api-sdk';

            const client = createAPIClient({ apiKey: 'my-api-key' });
            client.users.list().then(users => {
              console.log(users);
            });
        - lang: Java
          label: Java SDK
          source: |
            MyApiClient client = new MyApiClient("my-api-key");
            List<User> users = client.getUsers();
            System.out.println(users);

主なポイント

• x-codeSamples はコードサンプルオブジェクトの配列です。

• 各オブジェクトは次を定義します:

  • lang: コードの言語（例: JavaScript、Java）。

  • ラベル: コードブロックの短いラベル。

  • source: 実際のコードスニペット。