<RequestExample>
と <ResponseExample>
コンポーネントは、右サイドバーにコードブロックを表示し、コンテンツをスクロールしている間も例を見やすく保つための二列レイアウトを作成します。これらのコンポーネントは API ドキュメント向けに設計されていますが、すべてのページで使用できます。
主なユースケース:
- リクエストとレスポンスの例を伴う API エンドポイントのドキュメント
- 説明文に沿った設定例
- 手順に沿って参照できるコードサンプル
- チュートリアルにおける Before/After の例
<RequestExample>
と <ResponseExample>
コンポーネントは通常のコードブロックとして表示され、スクロールで通過できます。
RequestExample
<RequestExample>
を使用します。このコンポーネントは CodeGroup コンポーネントと同様に動作しますが、コードをインラインではなくサイドバーに表示します。
1つの <RequestExample>
内に複数のコードブロックを含められます。各コードブロックには title 属性が必要です。
RequestExample
ResponseExample
<ResponseExample>
コンポーネントは、同一ページ内の <RequestExample>
コンテンツの直下に、右サイドバーへコード例をピン留めします。
ResponseExample