OpenAPI 2.0

OpenAPI 2.0 文書の認証、通信の保護、リクエストとレスポンスの定義、参照を確認するための文書です。

文書一覧

文書 パス
本文パラメーターのschemaが未定義(OpenAPI 2.0) openAPI/2.0/body_parameter_without_schema
本文パラメーターの不正なプロパティ(OpenAPI 2.0) openAPI/2.0/body_parameter_with_wrong_property
OpenAPI 2.0でOAuth2暗黙的フローを定義 openAPI/2.0/implicit_flow_oauth2
全体の認証にOAuth2パスワードフローを使用 openAPI/2.0/global_security_using_password_flow
OpenAPI 2.0のOAuth2認可URLの誤設定 openAPI/2.0/invalid_oauth_authorization_url
OpenAPI 2.0のOAuth2トークンURLの誤り openAPI/2.0/invalid_oauth2_token_url
OpenAPI 2.0 オブジェクトの不明なプロパティ openAPI/2.0/unknown_property
OpenAPIの全体のスキームにHTTPを使用 openAPI/2.0/global_schemes_uses_http
操作で受け付けるリクエスト形式の未定義 openAPI/2.0/operation_object_without_consumes
操作が返すレスポンス形式の未定義 openAPI/2.0/operation_object_without_produces
OpenAPI 2.0の操作で使うBasic認証を確認 openAPI/2.0/operation_using_basic_auth
個別の操作にOAuth2暗黙的フローを使用 openAPI/2.0/operation_using_implicit_flow
個別の操作にOAuth2パスワードフローを使用 openAPI/2.0/operation_using_password_flow
OpenAPIの操作でHTTPを許可 openAPI/2.0/path_scheme_accepts_http
OpenAPI 2.0のBasic認証定義を確認 openAPI/2.0/security_definitions_using_basic_auth
セキュリティ定義でのOAuth2パスワードフローの使用 openAPI/2.0/security_definitions_allows_password_flow
OpenAPI 2.0 の追加プロパティの許可方針の確認 openAPI/2.0/schema_with_additional_properties_set_as_boolean
collectionFormat: multiの使用場所が不正(OpenAPI 2.0) openAPI/2.0/multi_collectionformat_not_valid_in_parameter
basePathの形式が不正(OpenAPI 2.0) openAPI/2.0/basepath_with_wrong_format
本文以外のパラメーターにschemaを使用(OpenAPI 2.0) openAPI/2.0/non_body_parameter_with_schema
OpenAPI 2.0 の enum と追加制約の整合性の確認 openAPI/2.0/constraining_enum_property
hostの形式が不正(OpenAPI 2.0) openAPI/2.0/host_with_invalid_pattern
OpenAPI 2.0 の操作の要約の長さの確認 openAPI/2.0/operation_summary_too_long
パラメーターオブジェクトの参照先が不正(OpenAPI 2.0) openAPI/2.0/parameter_object_incorrect_ref
レスポンスオブジェクトの参照先が不正(OpenAPI 2.0) openAPI/2.0/response_object_incorrect_ref
スキーマオブジェクトの参照先が不正(OpenAPI 2.0) openAPI/2.0/schema_object_incorrect_ref
認証方式が定義されていないOpenAPI 2.0ドキュメント openAPI/2.0/security_definitions_undefined_or_empty
未定義の認証方式を参照するOpenAPI 2.0ドキュメント openAPI/2.0/security_requirement_not_defined_in_security_definition
OpenAPI 2.0 のメディアタイプの書式エラー openAPI/2.0/invalid_media_type_value
OpenAPI 2.0 のメディアタイプの接頭辞の確認 openAPI/2.0/unknown_prefix
OAuth2以外の認証方式へのスコープの指定 openAPI/2.0/non_oauth2_security_requirement_defining_oauth2_scopes
未使用の共通パラメーター定義(OpenAPI 2.0) openAPI/2.0/unused_parameter_definition
未使用の共通レスポンス定義(OpenAPI 2.0) openAPI/2.0/unused_response_definition
未使用の共通スキーマ定義(OpenAPI 2.0) openAPI/2.0/unused_schema_definition
OpenAPI 2.0 の応答例と produces の不一致 openAPI/2.0/operation_example_mismatch_produces_mediatype
操作のセキュリティ要件で参照される未定義のOAuth2スコープ openAPI/2.0/undefined_security_scope_security_operations
OpenAPI 2.0 に記載された HTTP 通信 openAPI/2.0/schemes-http-vulnerabilities-iac-openapi-2.0-schemes_uses_http-copy-md
全体のセキュリティ要件で参照される未定義のOAuth2スコープ openAPI/2.0/undefined_security_scope_global_security
参照先のパラメーターが存在しない(OpenAPI 2.0) openAPI/2.0/json_reference_does_not_exists_parameter
参照先のレスポンスが存在しない(OpenAPI 2.0) openAPI/2.0/json_reference_does_not_exists_response
参照先のスキーマが存在しない(OpenAPI 2.0) openAPI/2.0/json_reference_does_not_exists_schema
OpenAPI 2.0 のモデルのプロパティ名の確認 openAPI/2.0/property_not_unique
ファイルパラメーターの場所が不正(OpenAPI 2.0) openAPI/2.0/parameter_file_type_not_in_formdata
ファイルアップロードのconsumes形式が不正(OpenAPI 2.0) openAPI/2.0/file_parameter_with_wrong_consumes_property
OpenAPI 2.0 オブジェクトの必須プロパティの不足 openAPI/2.0/object_without_required_property
1つの操作に複数の本文パラメーター(OpenAPI 2.0) openAPI/2.0/multi_body_parameters_same_operation
1つの操作でbodyとformDataを併用(OpenAPI 2.0) openAPI/2.0/operation_object_parameters_with_body_and_formatdata

関連ページ47

本文パラメーターのschemaが未定義(OpenAPI 2.0)

リクエスト本文のデータ構造を説明するschemaがない状態

本文パラメーターの不正なプロパティ(OpenAPI 2.0)

本文パラメーターのプロパティが標準フィールドにも拡張形式にも合わない状態

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

OAuth2暗黙的フローは、認可応答でアクセストークンを直接返します。

全体の認証にOAuth2パスワードフローを使用

OAuth2パスワードフローでは、クライアントがユーザーのパスワードを直接扱います。

OpenAPI 2.0のOAuth2認可URLの誤設定

OpenAPI 2.0のOAuth2認可URLが誤っていると、ログインや同意の手続きに失敗する可能性があります。

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

tokenUrlにはOAuth2プロバイダーの正しいトークン発行先を指定する必要があります。

OpenAPI 2.0 オブジェクトの不明なプロパティ

標準プロパティの誤記を修正し、対応する拡張形式を使用してください。

OpenAPIの全体のスキームにHTTPを使用

全体のschemesにHTTPを指定すると、暗号化されないAPI通信を案内することになります。

操作で受け付けるリクエスト形式の未定義

APIが受け付けるリクエスト本文のメディアタイプが記述されているか確認します。

操作が返すレスポンス形式の未定義

レスポンス本文のメディアタイプがOpenAPI 2.0に指定されているか確認します。

OpenAPI 2.0の操作で使うBasic認証を確認

操作ごとのBasic認証について、通信の保護と認証情報の再利用リスクを確認してください。

個別の操作にOAuth2暗黙的フローを使用

OAuth2暗黙的フローでは、認可応答でアクセストークンを直接受け取ります。

個別の操作にOAuth2パスワードフローを使用

操作の認証にOAuth2パスワードフローを使うと、クライアントがユーザーのパスワードを直接送信します。

OpenAPIの操作でHTTPを許可

操作ごとのschemesにHTTPを指定すると、その操作で平文通信を利用できることになります。

OpenAPI 2.0のBasic認証定義を確認

Basic認証定義の使用箇所と、認証情報の保護方法を確認してください。

セキュリティ定義でのOAuth2パスワードフローの使用

OAuth2のパスワードフローは利用者のパスワードをクライアントに渡すため、使用してはいけません。

OpenAPI 2.0 の追加プロパティの許可方針の確認

additionalProperties をデータ契約に合わせて選択してください。

collectionFormat: multiの使用場所が不正(OpenAPI 2.0)

queryやformData以外の配列でmultiを使っている状態

basePathの形式が不正(OpenAPI 2.0)

APIの共通パスがスラッシュで始まっていない状態

本文以外のパラメーターにschemaを使用(OpenAPI 2.0)

query、path、header、formDataパラメーターにschemaがある状態

OpenAPI 2.0 の enum と追加制約の整合性の確認

enum と併用する制約が意図した許容値と一致するか確認してください。

hostの形式が不正(OpenAPI 2.0)

APIホストにパスやプロトコルなどの不正な要素が含まれる状態

OpenAPI 2.0 の操作の要約の長さの確認

summary は簡潔にし、詳細は description に記載してください。

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

パラメーターが別の種類のオブジェクトを参照している状態

レスポンスオブジェクトの参照先が不正(OpenAPI 2.0)

レスポンスの代わりにデータスキーマなどを参照している状態

スキーマオブジェクトの参照先が不正(OpenAPI 2.0)

スキーマの位置でレスポンスなど別の種類のオブジェクトを参照している状態

認証方式が定義されていないOpenAPI 2.0ドキュメント

認証が必要なAPIでは、securityDefinitionsで認証方式を定義し、securityで適用します。

未定義の認証方式を参照するOpenAPI 2.0ドキュメント

securityの認証方式名はsecurityDefinitionsの定義と一致させる必要があります。

OpenAPI 2.0 のメディアタイプの書式エラー

consumes と produces に正しいメディアタイプを指定してください。

OpenAPI 2.0 のメディアタイプの接頭辞の確認

メディアタイプのタイプ名とサブタイプ名を正確に記載してください。

OAuth2以外の認証方式へのスコープの指定

OpenAPI 2.0のBasic認証とAPIキー認証では、セキュリティ要件のスコープ配列を空にします。

未使用の共通パラメーター定義(OpenAPI 2.0)

再利用可能なパラメーターが必要な場所で参照されていない状態

未使用の共通レスポンス定義(OpenAPI 2.0)

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

未使用の共通スキーマ定義(OpenAPI 2.0)

リクエストやレスポンスで使わない共通モデルが残っている状態

OpenAPI 2.0 の応答例と produces の不一致

応答例のメディアタイプを操作が対応する形式に合わせてください。

操作のセキュリティ要件で参照される未定義のOAuth2スコープ

OpenAPI 2.0の操作のセキュリティ要件が、未定義のOAuth2スコープを参照しています。

OpenAPI 2.0 に記載された HTTP 通信

API に記載された通信方式と実際の HTTPS 設定を確認してください。

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

OpenAPI 2.0の全体のセキュリティ要件が、定義されていないOAuth2スコープを参照しています。

参照先のパラメーターが存在しない(OpenAPI 2.0)

参照している共通パラメーターがない状態

参照先のレスポンスが存在しない(OpenAPI 2.0)

共通レスポンスへの参照が実際の定義名と一致しない状態

参照先のスキーマが存在しない(OpenAPI 2.0)

definitionsにないモデルを参照している状態

OpenAPI 2.0 のモデルのプロパティ名の確認

各モデルの意味に合う名前を付け、不要な API 契約の変更を避けてください。

ファイルパラメーターの場所が不正(OpenAPI 2.0)

type: fileパラメーターがformData以外にある状態

ファイルアップロードのconsumes形式が不正(OpenAPI 2.0)

リクエストのメディアタイプがファイルパラメーターと合わない状態

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

オブジェクトの種類と条件に応じた必須プロパティを記載してください。

1つの操作に複数の本文パラメーター(OpenAPI 2.0)

1つのAPI操作にin: bodyパラメーターが複数ある状態

1つの操作でbodyとformDataを併用(OpenAPI 2.0)

同じAPI操作で本文とフォームのパラメーターを併用している状態