> ## Documentation Index
> Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 添加 SDK 示例

> 为你的 API 文档添加 SDK 代码示例，使用 Speakeasy 和 Stainless 自动生成的多语言示例。

如果用户通过 SDK 而不是直接通过网络请求与你的 API 交互，你可以使用 `x-codeSamples` 扩展在 OpenAPI 文档中添加代码示例，并将其展示在 OpenAPI 页面中。

将此属性添加到任何请求方法。它具有以下模式。

<ParamField body="lang" type="string" required>
  代码示例所使用的编程语言。
</ParamField>

<ParamField body="label" type="string">
  示例的标签。在为同一端点提供多个示例时很有用。
</ParamField>

<ParamField body="source" type="string" required>
  示例的源代码。
</ParamField>

下面是一个植物追踪应用的代码示例，该应用同时提供 Bash CLI 工具和 JavaScript SDK。

```yaml theme={null}
paths:
  /plants:
    get:
      # ...
      x-codeSamples:
        - lang: bash
          label: 列出所有未浇水的植物
          source: |
            planter list -u
        - lang: javascript
          label: 列出所有未浇水的植物
          source: |
            const planter = require('planter');
            planter.list({ unwatered: true });
        - lang: bash
          label: 列出所有盆栽植物
          source: |
            planter list -p
        - lang: javascript
          label: 列出所有盆栽植物
          source: |
            const planter = require('planter');
            planter.list({ potted: true });
```


## Related topics

- [配置 AI 助手](/zh/assistant/configure.md)
- [格式化代码](/zh/create/code.md)
- [创建开发者文档](/zh/guides/developer-documentation.md)