示例

在桌面设备的右侧边栏显示代码块

<RequestExample> 和 <ResponseExample> 组件会在右侧边栏显示代码块，形成双栏布局，使示例在用户滚动阅读你的内容时始终可见。这些组件为 API 文档而设计，但适用于所有页面。

常见用例：

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

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

Request

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

Response

{ "status": "success" }

​

RequestExample

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

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

RequestExample

<RequestExample>

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

</RequestExample>

​

ResponseExample

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

ResponseExample

<ResponseExample>

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

</ResponseExample>