示例

<RequestExample> 和 <ResponseExample> 组件会在右侧边栏显示代码块，形成双栏布局，使用户在滚动阅读内容时始终能看到示例。请将这些组件用于 API 文档，但它们适用于所有页面。

常见用例：

• 带有请求与响应示例的 API 端点文档
• 与说明性文字并列的配置示例
• 供用户在按步骤操作时参考的代码示例
• 教程中的前后对比示例

在移动设备上，<RequestExample> 和 <ResponseExample> 组件会显示为常规代码块，用户可以直接滚动略过。

curl --request POST \
  --url https://dog-api.kinduff.com/api/facts

{ "status": "success" }

使用 <RequestExample> 将代码示例固定在右侧边栏。该组件与 CodeGroup 类似，但会在侧边栏显示代码，而非内联展示。

你可以在一个 <RequestExample> 中包含多个代码块。每个代码块都必须包含 title 属性。

<RequestExample>

```bash 请求
curl --request POST \
  --url https://dog-api.kinduff.com/api/facts
```

</RequestExample>

<ResponseExample> 组件会将代码示例固定在右侧边栏，位于同一页面中任意 <RequestExample> 的内容下方。

<ResponseExample>

```json 响应
{ "status": "success" }
```

</ResponseExample>

<RequestExample> 和 <ResponseExample> 均接受以下属性：