サポートされている JSON Schema キーワード
OpenAPI 3.0では、データ形式を記述するために、JSON Schema Specification Wright Draft 00（別名Draft 5）の拡張サブセットを使用しています。「拡張サブセット」とは、一部のキーワードがサポートされ、一部がサポートされていないこと、一部のキーワードはJSON Schemaとはわずかに異なる使用法を持つこと、および追加のキーワードが導入されていることを意味します。
対応キーワード
これらのキーワードはJSONスキーマと同じ意味を持ちます
titlepatternrequiredenumminimummaximumexclusiveMinimumexclusiveMaximummultipleOfminLengthmaxLengthminItemsmaxItemsuniqueItemsminPropertiesmaxProperties
これらのキーワードはわずかな違いでサポートされています
type– 値は単一の型である必要があり、型の配列であってはなりません。nullは型としてサポートされていません。代わりにnullable: trueキーワードを使用してください。format– OpenAPIには独自の事前定義されたフォーマットがあり、カスタムフォーマットも許可されています。description– リッチテキスト表現のためにCommonMark構文をサポートしています。items–typeがarrayの場合、存在する必要があります。項目スキーマは、標準のJSONスキーマではなく、OpenAPIスキーマである必要があります。properties– 個々のプロパティ定義は、標準のJSONスキーマではなく、OpenAPIスキーマの規則に従う必要があります。additionalProperties– 値はブール値（trueまたはfalse）またはOpenAPIスキーマのいずれかです。default– デフォルト値は指定されたスキーマに準拠する必要があります。allOf– サブスキーマは、標準のJSONスキーマではなく、OpenAPIスキーマである必要があります。oneOf– サブスキーマは、標準のJSONスキーマではなく、OpenAPIスキーマである必要があります。anyOf– サブスキーマは、標準のJSONスキーマではなく、OpenAPIスキーマである必要があります。not– サブスキーマは、標準のJSONスキーマではなく、OpenAPIスキーマである必要があります。
非対応キーワード
$schemaadditionalItemsconstcontainsdependenciesid,$idpatternPropertiespropertyNames
追加キーワード
OpenAPIスキーマは、JSONスキーマの一部ではない以下のキーワードも使用できます
参照
JSONスキーマ検証 – JSONスキーマキーワードリファレンス
JSONスキーマドラフトWright 00 – コアJSONスキーマ仕様
お探しのものが見つかりませんでしたか？ コミュニティに質問する
間違いを見つけましたか？ お知らせください