OpenAPI 3.0

OpenAPI 3.0 文書のセキュリティ設定、スキーマ、メディアタイプ、コンポーネントの参照を確認するための文書です。

文書一覧

文書 パス
コールバックオブジェクトの参照先が不正(OpenAPI 3.0) openAPI/3.0/callback_object_incorrect_ref
未使用の OpenAPI 3.0 コールバックコンポーネント openAPI/3.0/components_callback_definition_unused
未使用の例コンポーネント(OpenAPI 3.0) openAPI/3.0/components_example_definition_unused
未使用のヘッダーコンポーネント(OpenAPI 3.0) openAPI/3.0/components_header_definition_unused
未使用の OpenAPI 3.0 リンクコンポーネント openAPI/3.0/components_link_definition_unused
OpenAPI 3.0 のコンポーネント名の書式エラー openAPI/3.0/components_object_fixed_field_key_improperly_named
未使用のパラメーターコンポーネント(OpenAPI 3.0) openAPI/3.0/components_parameter_definition_unused
未使用のリクエスト本文コンポーネント(OpenAPI 3.0) openAPI/3.0/components_request_body_definition_unused
未使用のレスポンスコンポーネント(OpenAPI 3.0) openAPI/3.0/components_response_definition_unused
未使用のスキーマコンポーネント(OpenAPI 3.0) openAPI/3.0/components_schema_definition_unused
OpenAPI 3.0 の空配列の意味の確認 openAPI/3.0/empty_array
OpenAPI 3.0 のエンコーディングの Content-Type の配置エラー openAPI/3.0/encoding_header_content_type_improperly_defined
OpenAPI 3.0 の encoding キーとスキーマのプロパティの不一致 openAPI/3.0/encoding_map_key_mismatch_schema_defined_properties
例示オブジェクトの参照先が不正(OpenAPI 3.0) openAPI/3.0/example_json_reference_outside_components_examples
OpenAPIのHTTP Basic認証の保護設定を確認 openAPI/3.0/security_scheme_using_http_basic
HTTP Digest認証の設定確認(OpenAPI 3.0) openAPI/3.0/security_scheme_using_http_digest
HTTP Negotiate認証の設定確認(OpenAPI 3.0) openAPI/3.0/security_scheme_using_http_negotiate
HTTP認証方式の設定の確認 openAPI/3.0/security_schemes_http_unknown_scheme
ヘッダーオブジェクトの参照先が不正(OpenAPI 3.0) openAPI/3.0/header_object_with_incorrect_ref
ヘッダー値の形式の未定義 openAPI/3.0/header_object_without_schema
API本文のスキーマの未定義 openAPI/3.0/media_type_object_without_schema
従来の OAuth セキュリティスキームの確認 openAPI/3.0/security_schemes_using_oauth
OpenAPI 3.0のOAuth2認可URLの誤設定 openAPI/3.0/invalid_oauth_authorization_url
OpenAPI 3.0のOAuth2トークンURLの誤り openAPI/3.0/invalid_oauth2_token_url
OpenAPI 3.0でOAuth2暗黙的フローを定義 openAPI/3.0/oauth2_with_implicit_flow
OpenAPI 3.0でOAuth2パスワードフローを定義 openAPI/3.0/oauth2_with_password_flow
OpenAPI 3の操作で要求される未定義のOAuth2スコープ openAPI/3.0/undefined_security_scope_security_operations
OpenAPI 3の全体のセキュリティ要件で参照される未定義のOAuth2スコープ openAPI/3.0/undefined_security_scope_global_security
OpenAPIのプロパティ名と配置の確認 openAPI/3.0/unknown_property
OpenAPI 3.0 オブジェクトの必須プロパティが不足 openAPI/3.0/object_without_required_property
追加プロパティの制限が厳しすぎる(OpenAPI 3.0) openAPI/3.0/additional_properties_too_restrective
追加プロパティの許容範囲が広すぎる(OpenAPI 3.0) openAPI/3.0/additional_properties_too_permissive
OpenAPI 3.0の操作で使うBasic認証の通信保護を確認 openAPI/3.0/cleartext_credentials_with_basic_auth_for_operation
パラメーター値の形式の未定義 openAPI/3.0/parameter_object_without_schema
OpenAPIの操作の接続先でHTTPを使用 openAPI/3.0/path_server_uses_http
認証方式の定義の欠落 openAPI/3.0/security_scheme_undefined
TRACEの成功レスポンスが未定義(OpenAPI 3.0) openAPI/3.0/success_response_code_undefined_trace_operation
パラメーターの allowEmptyValue の適用範囲を確認 openAPI/3.0/property_allow_empty_value_ignored
適用対象外のパラメーター位置に allowReserved がある openAPI/3.0/property_allow_reserved_improperly_defined
Encoding オブジェクトの allowReserved の適用範囲を確認 openAPI/3.0/property_allow_reserved_encoding_object_ignored
Encoding オブジェクトの explode の適用範囲を確認 openAPI/3.0/property_explode_encoding_object_ignored
Encoding オブジェクトの style の適用範囲を確認 openAPI/3.0/property_type_encoding_object_ignored
リンクオブジェクトの参照先が不正(OpenAPI 3.0) openAPI/3.0/link_object_incorrect_ref
OpenAPI リンクに operationId と operationRef を同時指定 openAPI/3.0/link_object_with_both_operation_id_and_operation_ref
OpenAPI リンクの operationId に対応する操作がない openAPI/3.0/link_object_operation_id_does_not_target_an_operation_object
操作のセキュリティ要件が未定義のスキームを参照している openAPI/3.0/security_operation_field_undefined
パラメーターオブジェクトの参照先が不正(OpenAPI 3.0) openAPI/3.0/parameter_object_incorrect_ref
Parameter オブジェクトに schema と content が併記されている openAPI/3.0/parameter_object_schema_content
Parameter オブジェクトに schema または content がない openAPI/3.0/parameter_object_undefined_type
OpenAPI 3.0 パラメーターの content に複数の項目 openAPI/3.0/parameter_object_content_with_multiple_entries
リクエスト本文オブジェクトの参照先が不正(OpenAPI 3.0) openAPI/3.0/request_body_incorrect_ref
リクエスト本文の encoding とメディアタイプが不一致 openAPI/3.0/request_body_object_with_incorrect_media_type
レスポンスオブジェクトの参照先が不正(OpenAPI 3.0) openAPI/3.0/response_object_incorrect_ref
スキーマオブジェクトの参照先が不正(OpenAPI 3.0) openAPI/3.0/schema_object_incorrect_ref
スキーマのプロパティで readOnly と writeOnly が競合 openAPI/3.0/schema_with_both_read_only_and_write_only
スコープに対応していない認証方式へのスコープの指定 openAPI/3.0/security_requirement_object_with_wrong_scopes
サーバーURLの変数定義が不足している openAPI/3.0/server_url_uses_undefined_variables
相対サーバーURLの基準アドレスの確認 openAPI/3.0/server_url_not_absolute
OpenAPIのデフォルトサーバーアドレスの確認 openAPI/3.0/servers_undefined
OpenAPIのメディアタイプのプレフィックスの確認 openAPI/3.0/unknown_prefix
OpenAPI 3.0 の複数ファイルアップロードのメディアタイプの確認 openAPI/3.0/invalid_content_type_for_multiple_files_upload
OpenAPI 3.0 のメディアタイプの書式エラー openAPI/3.0/invalid_media_type_value
OpenAPI 3.0の再利用可能なBasic認証定義を確認 openAPI/3.0/global_security_scheme_using_basic_authentication
OpenAPIの既定の接続先のHTTPS設定を確認 openAPI/3.0/global_server_uses_http
グローバルなセキュリティ要件が未定義のスキームを参照している openAPI/3.0/security_field_undefined
APIキー認証の設定確認(OpenAPI 3.0) openAPI/3.0/api_key_exposed_in_global_security_scheme
サーバーURLで使われていない変数 openAPI/3.0/server_object_variable_not_used
OpenAPI 3.0 のコールバック参照先が存在しない openAPI/3.0/json_reference_does_not_exists_callback
OpenAPI 3.0 の例の参照先が存在しない openAPI/3.0/json_reference_does_not_exists_example
OpenAPI 3.0 のヘッダー参照先が存在しない openAPI/3.0/json_reference_does_not_exists_header
OpenAPI 3.0 のリンク参照先が存在しない openAPI/3.0/json_reference_does_not_exists_link
OpenAPI 3.0 のパラメーター参照先が存在しない openAPI/3.0/json_reference_does_not_exists_parameter
OpenAPI 3.0 のリクエスト本文の参照先が存在しない openAPI/3.0/json_reference_does_not_exists_request_body
OpenAPI 3.0 の応答参照先が存在しない openAPI/3.0/json_reference_does_not_exists_response
OpenAPI 3.0 のスキーマ参照先が存在しない openAPI/3.0/json_reference_does_not_exists_schema

関連ページ75

コールバックオブジェクトの参照先が不正(OpenAPI 3.0)

コールバックが有効な定義を参照していない状態

未使用の OpenAPI 3.0 コールバックコンポーネント

必要なコールバックを操作から参照し、不要な定義を整理してください。

未使用の例コンポーネント(OpenAPI 3.0)

再利用可能な例がAPIの説明に結び付いていない状態

未使用のヘッダーコンポーネント(OpenAPI 3.0)

共通ヘッダー定義が実際の使用箇所に結び付いていない状態

未使用の OpenAPI 3.0 リンクコンポーネント

必要なリンクを応答から参照し、不要な定義を整理してください。

OpenAPI 3.0 のコンポーネント名の書式エラー

コンポーネント名には英字、数字、ピリオド、ハイフン、アンダースコアを使用してください。

未使用のパラメーターコンポーネント(OpenAPI 3.0)

再利用可能なパラメーターがパスや操作に適用されていない状態

未使用のリクエスト本文コンポーネント(OpenAPI 3.0)

共通のリクエスト本文定義がAPI操作に結び付いていない状態

未使用のレスポンスコンポーネント(OpenAPI 3.0)

共通レスポンスの定義が実際の操作のレスポンスに結び付いていない状態

未使用のスキーマコンポーネント(OpenAPI 3.0)

実際のデータ契約に使わないモデル定義が残っている状態

OpenAPI 3.0 の空配列の意味の確認

空配列を一律に埋めず、各フィールドの意味を確認してください。

OpenAPI 3.0 のエンコーディングの Content-Type の配置エラー

multipart の各パートのメディアタイプは encoding の contentType で指定してください。

OpenAPI 3.0 の encoding キーとスキーマのプロパティの不一致

encoding のキーをスキーマに定義されたプロパティ名と一致させてください。

例示オブジェクトの参照先が不正(OpenAPI 3.0)

例示データの代わりにスキーマなど別の種類のオブジェクトを参照している状態

OpenAPIのHTTP Basic認証の保護設定を確認

HTTP Basic認証で使用する認証情報と通信を保護してください。

HTTP Digest認証の設定確認(OpenAPI 3.0)

Digest認証の通信保護とパスワードの強度を確認する必要がある状態

HTTP Negotiate認証の設定確認(OpenAPI 3.0)

Negotiateの環境との適合性と通信保護を確認する必要がある状態

HTTP認証方式の設定の確認

OpenAPI 3.0のHTTP認証方式が、実装と利用するツールに対応しているか確認します。

ヘッダーオブジェクトの参照先が不正(OpenAPI 3.0)

レスポンスヘッダーが有効なヘッダーオブジェクトを参照していない状態

ヘッダー値の形式の未定義

OpenAPI 3.0のヘッダー値の形式をschemaまたはcontentで定義します。

API本文のスキーマの未定義

リクエストとレスポンスの本文の構造が伝わるようにスキーマを定義します。

従来の OAuth セキュリティスキームの確認

従来の OAuth のサポート状況と、API が実際に使う認証フローを確認してください。

OpenAPI 3.0のOAuth2認可URLの誤設定

OpenAPI 3.0のOAuth2認可URLが、正しい認可サーバーのエンドポイントを指しているか確認します。

OpenAPI 3.0のOAuth2トークンURLの誤り

OAuth2フローのtokenUrlには、プロバイダーの正しいHTTPSトークンエンドポイントを指定する必要があります。

OpenAPI 3.0でOAuth2暗黙的フローを定義

OAuth2暗黙的フローは、認可応答でアクセストークンを直接返すため、漏えいの危険が高まります。

OpenAPI 3.0でOAuth2パスワードフローを定義

OAuth2パスワードフローでは、ユーザーのパスワードがクライアントに渡ります。

OpenAPI 3の操作で要求される未定義のOAuth2スコープ

OpenAPI 3.0の操作が、OAuth2の定義にないスコープを要求しています。

OpenAPI 3の全体のセキュリティ要件で参照される未定義のOAuth2スコープ

OpenAPI 3.0の全体のセキュリティ要件とOAuth2スコープの定義が一致していません。

OpenAPIのプロパティ名と配置の確認

各オブジェクトで許可されるプロパティ名と配置を確認してください。

OpenAPI 3.0 オブジェクトの必須プロパティが不足

各 OpenAPI オブジェクトに必要な必須プロパティを含めてください。

追加プロパティの制限が厳しすぎる(OpenAPI 3.0)

追加プロパティの制限がAPIで許可すべきフィールドまで拒否する状態

追加プロパティの許容範囲が広すぎる(OpenAPI 3.0)

定義済みのフィールドだけを許可すべきオブジェクトが追加プロパティを受け入れる状態

OpenAPI 3.0の操作で使うBasic認証の通信保護を確認

Basic認証を使う操作が、実際にHTTPSで接続することを確認してください。

パラメーター値の形式の未定義

OpenAPI 3.0のパラメーターの型と表現方法をschemaまたはcontentで指定します。

OpenAPIの操作の接続先でHTTPを使用

操作の接続先にHTTPを指定すると、そのAPI呼び出しが平文通信になる可能性があります。

認証方式の定義の欠落

認証が必要なAPIの認証方式が、OpenAPI 3.0に定義されているか確認します。

TRACEの成功レスポンスが未定義(OpenAPI 3.0)

サポートしているTRACE操作の成功レスポンスが文書にない状態

パラメーターの allowEmptyValue の適用範囲を確認

allowEmptyValue の適用範囲と実際の空値の処理を確認してください。

適用対象外のパラメーター位置に allowReserved がある

パラメーターの allowReserved は query でのみ使用してください。

Encoding オブジェクトの allowReserved の適用範囲を確認

encoding.allowReserved は対応する URL エンコード形式のフォーム本文で使用してください。

Encoding オブジェクトの explode の適用範囲を確認

本文の形式と値の型に合わせて encoding.explode を使用してください。

Encoding オブジェクトの style の適用範囲を確認

URL エンコード形式のフォームフィールドに適した直列化スタイルを指定してください。

リンクオブジェクトの参照先が不正(OpenAPI 3.0)

後続のAPI操作を示すリンクの参照が不正な状態

OpenAPI リンクに operationId と operationRef を同時指定

リンク先は operationId または operationRef のどちらかで指定してください。

OpenAPI リンクの operationId に対応する操作がない

リンクの operationId を文書に定義された一意の操作 ID と一致させてください。

操作のセキュリティ要件が未定義のスキームを参照している

操作ごとのセキュリティ要件が正しいスキームを参照するようにしてください。

パラメーターオブジェクトの参照先が不正(OpenAPI 3.0)

パラメーターが正しい種類の定義を参照していない状態

Parameter オブジェクトに schema と content が併記されている

パラメーターには schema または content のどちらか一方を定義してください。

Parameter オブジェクトに schema または content がない

パラメーター値の形式を schema または content で定義してください。

OpenAPI 3.0 パラメーターの content に複数の項目

パラメーターの content には一つのメディアタイプだけを指定してください。