添加自定义代码示例

了解如何配置自定义代码示例，以在你的 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：实际的代码片段。