フィールドを使って、API のパラメータとレスポンスを記述します。フィールドには、パラメータフィールドとレスポンスフィールドの 2 種類があります。

​
パラメータフィールド

<ParamField> コンポーネントは、API や SDK のパラメータを定義するために使用します。ParamField を追加すると、APIプレイグラウンドが自動的に追加されます。
​
param
string
required
パラメータフィールドの例
<ParamField path="param" type="string" required>
  パラメータフィールドの例
</ParamField>

​
プロパティ

​
query, path, body, or header
string
パラメータが query、path、body、header のいずれであるかを示します。続いて パラメータ名を記載します。
​
type
string
パラメータ値の想定される型。number、string、boolean、object をサポートします。配列は [] のサフィックスで定義できます（例: string[]）。
​
required
boolean
パラメータが必須かどうかを示します。
​
deprecated
boolean
パラメータが非推奨かどうかを示します。
​
default
any
リクエスト値が空の場合に適用されるデフォルト値。
​
placeholder
string
プレイグラウンドの入力欄に表示するプレースホルダーテキスト。
​
children
string
パラメータの説明（Markdown 対応）。

​
レスポンスフィールド

<ResponseField> コンポーネントは、API の返値を定義します。
​
response
string
required
レスポンスフィールドの例
<ResponseField name="response" type="string" required>
  レスポンスフィールドの例
</ResponseField>

​
プロパティ

​
name
string
required
レスポンス値の名称。
​
type
string
required
レスポンス値の想定される型。任意の文字列を指定できます。
​
default
string
デフォルト値。
​
required
boolean
レスポンスが必須かどうかを示します。
​
deprecated
boolean
フィールドが非推奨かどうか。
​
pre
string[]
フィールド名の前に表示されるラベル。
​
post
string[]
フィールド名の後に表示されるラベル。