curl --request POST \
    --url https://dog-api.kinduff.com/api/facts
{ "status": "success" }
<RequestExample><ResponseExample> 组件会在右侧边栏显示代码块,形成双栏布局,确保在用户滚动阅读内容时示例始终可见。这些组件为 API 文档而设计,但适用于所有页面。 常见用例:
  • 带有请求与响应示例的 API 端点文档
  • 解释性文本旁的配置示例
  • 用户在按步骤操作时参考的代码示例
  • 教程中的前后对比示例
在移动设备上,<RequestExample><ResponseExample> 组件会显示为常规代码块,用户可直接滚动略过。
  curl --request POST \
    --url https://dog-api.kinduff.com/api/facts
{ "status": "success" }

RequestExample

使用 <RequestExample> 将代码示例固定在右侧边栏。该组件与 CodeGroup 组件类似,但会将代码显示在侧边栏而不是内联展示。 你可以在单个 <RequestExample> 中包含多个代码块。每个代码块都必须带有 title 属性。
RequestExample
<RequestExample>

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

</RequestExample>

ResponseExample

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

```json Response
{ "status": "success" }
```

</ResponseExample>