mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
e42653a294
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
50 lines
1.5 KiB
Plaintext
50 lines
1.5 KiB
Plaintext
---
|
|
title: "添加 SDK 示例"
|
|
description: "在 API 文档中展示 SDK 代码示例。"
|
|
keywords: ["x-codeSamples", "SDK examples"]
|
|
---
|
|
|
|
如果用户通过 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
|
|
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 });
|
|
```
|