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 authorizationUrl 잘못된 설정 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
Operation consumes 미설정 openAPI/2.0/operation_object_without_consumes
Operation produces 미설정 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
Security Definitions에 Password Flow 허용 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 인증에 OAuth2 Scope 사용 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
작업별 보안 설정에 정의되지 않은 OAuth Scope 사용 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
전역 보안 설정에 정의되지 않은 OAuth Scope 사용 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
한 작업에 여러 본문 매개변수 사용 (OpenAPI 2.0) openAPI/2.0/multi_body_parameters_same_operation
한 작업에 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 authorizationUrl 잘못된 설정

OpenAPI 2.0의 OAuth2 인가 URL이 잘못 설정되어 로그인과 동의 절차가 실패할 수 있습니다.

OpenAPI 2.0의 잘못된 OAuth2 토큰 URL

tokenUrl은 OAuth2 제공자의 올바른 토큰 발급 주소여야 합니다.

OpenAPI 2.0 객체의 알 수 없는 속성

표준 속성의 오타를 수정하고 지원되는 확장 형식을 사용하세요.

OpenAPI 전역 스킴에 HTTP 사용

전역 schemes의 HTTP 설정은 암호화되지 않은 API 통신을 안내합니다.

Operation consumes 미설정

요청 본문을 받는 API의 미디어 유형이 명확히 문서화되어 있는지 확인합니다.

Operation produces 미설정

응답 본문의 미디어 유형이 OpenAPI 2.0 문서에 명시되어 있는지 확인합니다.

OpenAPI 2.0 작업의 Basic 인증 점검

작업별 Basic 인증의 전송 보호와 자격 증명 재사용 위험을 확인하세요.

개별 작업에 OAuth2 암시적 흐름 사용

작업이 OAuth2 암시적 흐름을 요구하면 클라이언트는 인가 응답에서 액세스 토큰을 직접 받습니다.

개별 작업에 OAuth2 비밀번호 흐름 사용

작업별 인증에서 OAuth2 비밀번호 흐름을 사용하면 클라이언트가 사용자 비밀번호를 직접 전달합니다.

OpenAPI 작업에 HTTP 사용

작업별 schemes에 HTTP가 있으면 해당 작업의 평문 통신이 안내됩니다.

OpenAPI 2.0의 Basic 인증 정의 점검

Basic 인증 정의의 실제 사용 여부와 자격 증명 보호 방식을 확인하세요.

Security Definitions에 Password Flow 허용

OAuth2 password 흐름은 클라이언트가 사용자 비밀번호를 직접 처리하므로 사용해서는 안 됩니다.

OpenAPI 2.0 추가 속성 허용 정책 점검

additionalProperties를 데이터 계약에 맞게 선택하세요.

collectionFormat: multi의 위치 오류 (OpenAPI 2.0)

배열의 multi 형식을 query나 formData 외의 위치에서 사용하는 경우

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 인증에 OAuth2 Scope 사용

OpenAPI 2.0의 Basic 인증이나 API 키 인증에는 보안 요구사항의 스코프 배열을 비워 두어야 합니다.

사용하지 않는 전역 매개변수 정의 (OpenAPI 2.0)

재사용 매개변수가 필요한 곳에서 참조되지 않는 경우

사용하지 않는 전역 응답 정의 (OpenAPI 2.0)

공통 응답 정의가 작업과 연결되지 않은 경우

사용하지 않는 전역 스키마 정의 (OpenAPI 2.0)

요청이나 응답에 사용하지 않는 공통 모델이 남아 있는 경우

OpenAPI 2.0 응답 예제와 produces 불일치

응답 예제의 미디어 타입을 작업이 지원하는 형식과 일치시키세요.

작업별 보안 설정에 정의되지 않은 OAuth Scope 사용

OpenAPI 2.0의 작업별 보안 설정에서 정의되지 않은 OAuth2 스코프를 참조합니다.

OpenAPI 2.0에 명시된 HTTP 전송

API 문서의 전송 방식과 실제 HTTPS 설정을 함께 확인하세요.

전역 보안 설정에 정의되지 않은 OAuth Scope 사용

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 객체의 필수 속성 누락

객체 종류와 조건에 맞는 필수 속성을 작성하세요.

한 작업에 여러 본문 매개변수 사용 (OpenAPI 2.0)

하나의 API 작업에 in: body 매개변수가 여러 개 있는 경우

한 작업에 body와 formData 혼용 (OpenAPI 2.0)

같은 API 작업에서 본문과 폼 매개변수를 함께 사용하는 경우