<RequestExample>
和 <ResponseExample>
组件会在右侧边栏显示代码块,形成双栏布局,让示例在用户滚动浏览内容时始终可见。这些组件为 API 文档而设计,但适用于所有页面。
常见用法:
- 带请求与响应示例的 API 端点文档
- 将配置示例与说明性文本并排展示
- 供用户在按照步骤操作时参考的代码示例
- 教程中的前后对比示例
<RequestExample>
和 <ResponseExample>
组件会显示为常规代码块,可直接滑动略过。
RequestExample
<RequestExample>
将代码示例固定到右侧边栏。该组件与 CodeGroup 类似,但会在侧边栏显示代码,而非内联展示。
你可以在一个 <RequestExample>
中包含多个代码块。每个代码块都必须包含 title 属性。
RequestExample
ResponseExample
<ResponseExample>
组件会将代码示例固定在右侧边栏,位于同一页面中任意 <RequestExample>
的内容下方。
ResponseExample