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

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: 実際のコードスニペット。

クイックガイド

Fern からカスタムコードサンプルを追加するにはどうすればよいですか？

Fern で生成された SDK の例を、OpenAPI 定義内のカスタムコードサンプルとして使用します。

このガイドでは、生成された例の見つけ方、フォーマット x-codeSamples方法、および API 操作への追加方法を説明します。

Stainless からカスタムコードサンプルを追加するにはどうすればよいですか？

Stainless で生成された SDK の例を、OpenAPI 定義内のカスタムコードサンプルとして使用します。

このガイドでは、生成された例の見つけ方、フォーマット x-codeSamples方法、および API 操作への追加方法を説明します。

HeyAPI からカスタムコードサンプルを追加するにはどうすればよいですか？

HeyAPI で生成された SDK の例を、OpenAPI 定義内のカスタムコードサンプルとして使用します。

このガイドでは、生成された例の見つけ方、フォーマット x-codeSamples方法、および API 操作への追加方法を説明します。