RESTful APIにはスキーマが必要ですか？

Question

最近、適切なRESTful APIが受け入れて返すリソース表現のスキーマを定義する必要があると言われました。たとえば、XMLのXSDとJSONのJSONスキーマ。

しかし、RESTのすべての本と記事で、これを目撃したことは、目立っただけでなく、言及されたこともありませんでした。

RESTful APIを開発するときにスキーマを提供する必要があるかどうかを明確にするために、誰かが信頼できるリソースを提供できますか？

kjhughes · Accepted Answer

リクエストとレスポンスのインターフェースをRESTful APIに定義して伝達する必要があります何らかの方法応答で。

RESTful API：スキーマと他のインターフェース定義

schema（XSD、JSON Schemaなど）を使用するか、何らかのother形式（自然言語、例など）を使用するか、またはインターフェースを定義するためのいくつかの組み合わせを決定するのはあなた次第です。決定を知らせるfactorsを次に示します。

使用する規則の周知度

スキーマ：XSDは多くの業界で使用されているW3C標準です。 JSONスキーマは、JSONのXSDのよく知られた代替手段です。

その他：自然言語と例は実行可能で非常に有用ですが、あいまいまたは不完全です。
どのコンベンションがあなたのコミュニティに最も感謝しますか。

スキーマ：XSDは、特に業界の標準XSDの開発にすでに投資しているコミュニティから高く評価される傾向があります。

その他：自然言語と例は、初心者に高く評価される傾向があります。
使用する検証プロセスの自動化可能性

スキーマ：XSDスキーマとJSONスキーマの両方が、既製の自動検証を提供します。

その他：自然言語と例では、検証のためにアドホックな作業が必要です。
使用するインターフェイスの厳密な型指定または緩い型指定。

スキーマ：XSDとJSONは、さまざまなタイプの特異性を表現できますが、詳細なタイプの特異性が必要な場合に輝きます。

その他：自然言語と例は、しばしば不正確ではありますが、型の要件を伝えることができます。