添加自定义代码示例

了解如何配置自定义代码示例以在您的 API 端点旁显示。

GitBook 可以为每个 API 操作自动生成通用代码示例。如果您希望展示自定义或更详细的片段，请在您的 OpenAPI 定义中添加 x-codeSamples 。通过这种方式，您可以控制端点的展示方式并提供特定语言或 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: 实际的代码片段。