入力スキーマとフィールド型

入力スキーマは、APIを利用する際に送信が必要な項目を記述したものです。たとえば気象データを提供するAPIであれば、都市や日付が必要になります。ここで入力するのは、まさにその内容です。

項目ごとに、次の内容を定めます。

• 名称（たとえばcityやdate）、
• 型（都市名ならテキスト、日付なら日付）、
• その項目が必須かどうか（必須）。

これにより、人もプログラムも、APIに何を送信すべきかが正確に分かります。出力スキーマも仕組みは同じで、APIが何を返すか（たとえばtemperatureを数値として）を記述します。

技術的な知識がある場合は、フォームで「JSONを直接入力」に切り替え、スキーマをJSON形式で自分で指定できます。

フィールド型

入力と出力を記述する際は、項目ごとに型を選びます。型は、どの種類の値が期待されるかを示します。主なものは次のとおりです。

• テキスト（Text）は単語や文に使用します。たとえばHamburgのような都市名です。
• 数値（Number）は数量に使用します。たとえば気温（21）や価格です。
• 日付（Date）は暦日に使用します。たとえば2025-06-16です。
• ブール値（Boolean、はい／いいえ）は真偽の値に使用します。たとえばactive: yesです。
• メール（Email）は、メールアドレスに使用します。形式はゲートウェイでは確認しません。
• URLはウェブアドレスに使用します。たとえばhttps://…です。

項目に最も適した型を選んでください。迷う場合はテキスト（Text）が安全な選択です。