添加自定义代码示例

了解如何配置自定义代码示例，以便在 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);
            });
        - 语言：Java
          标签：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 添加自定义代码示例？

在你的 OpenAPI 定义中使用 Fern 生成的 SDK 示例作为自定义代码示例。

本指南涵盖查找生成的示例、格式化 x-codeSamples，以及将它们添加到 API 操作中。

如何从 Stainless 添加自定义代码示例？

在你的 OpenAPI 定义中使用 Stainless 生成的 SDK 示例作为自定义代码示例。

本指南涵盖查找生成的示例、格式化 x-codeSamples，以及将它们添加到 API 操作中。

如何从 HeyAPI 添加自定义代码示例？

在你的 OpenAPI 定义中使用 HeyAPI 生成的 SDK 示例作为自定义代码示例。

本指南涵盖查找生成的示例、格式化 x-codeSamples，以及将它们添加到 API 操作中。