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 Security Scheme 값 점검 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
Media Type Object에 Schema 없음 openAPI/3.0/media_type_object_without_schema
레거시 OAuth 보안 스키마 점검 openAPI/3.0/security_schemes_using_oauth
OpenAPI 3.0의 OAuth2 authorizationUrl 잘못된 설정 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 작업별 보안 설정에 정의되지 않은 scope를 사용하는 경우 openAPI/3.0/undefined_security_scope_security_operations
OpenAPI 3 전역 보안 설정에 정의되지 않은 scope를 사용하는 경우 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
Security Scheme 정의 없음 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
security requirement에 잘못된 스코프를 사용하는 경우 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 Security Scheme 값 점검

OpenAPI 3.0의 HTTP 인증 방식이 실제 구현 및 도구의 지원 범위와 일치하는지 확인합니다.

잘못된 헤더 객체 참조 (OpenAPI 3.0)

응답 헤더의 참조 대상이 유효한 헤더 객체가 아닌 경우

헤더 값 형식 정의 누락

OpenAPI 3.0 헤더 값의 타입과 형식을 schema 또는 content로 정의합니다.

Media Type Object에 Schema 없음

요청과 응답 본문의 구조를 명확히 전달할 수 있도록 스키마를 정의합니다.

레거시 OAuth 보안 스키마 점검

레거시 OAuth 구성의 지원 상태와 실제 인증 흐름을 검토하세요.

OpenAPI 3.0의 OAuth2 authorizationUrl 잘못된 설정

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 작업별 보안 설정에 정의되지 않은 scope를 사용하는 경우

OpenAPI 3.0의 개별 작업에서 OAuth2 정의에 없는 스코프를 요구합니다.

OpenAPI 3 전역 보안 설정에 정의되지 않은 scope를 사용하는 경우

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 호출이 평문으로 전송될 수 있습니다.

Security Scheme 정의 없음

인증이 필요한 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에는 하나의 미디어 타입만 지정하세요.