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

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）。

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

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