OpenAPI 사양 통합

대상 API에 대한 OpenAPI 사양(버전 3.0.0 이상)입니다.

API 인증 자격 증명(API 키, OAuth 또는 기타).

Amazon Quick Author 이상.

API 설명서 및 엔드포인트 액세스.

OpenAPI 버전 - 버전 3.0.0 이상이 필요합니다.

파일 형식 - JSON 형식만(application/json).

파일 크기 제한 - 전체 OpenAPI 사양에 대해 최대 1MB입니다.

작업 제한 - 커넥터당 최소 1개 및 최대 100개의 API 작업.

경로 패턴 - 패턴을 따르고 슬래시(/)로 ^/[^/]*(/[^/]*)*$ 시작해야 합니다.

작업 IDs - 패턴을 따라야 합니다^[a-zA-Z0-9_ ]{1,256}$.

설명 - 모든 작업 및 파라미터에 필요하며 최대 5,000자입니다.

콘텐츠 유형 - 요청 및 응답 본문에는 application/json만 지원됩니다.

배열 유형 - 배열 유형(예: {"type": "array", "items": {"string"}})이 있는 스키마는 지원되지 않습니다.

구성 키워드 - allOf, oneOf, anyOf, not 키워드는 지원되지 않습니다.

순환 참조 - 순환 또는 순환 참조($ref 내부 $ref)는 지원되지 않습니다.

복잡한 중첩 구조 - 가능하면 깊이 중첩된 객체 구조를 피합니다.

작업 설명 - 작업이 수행하는 작업, 작업 사용 시기 및 작동 방식을 설명합니다.

파라미터 설명 - 파라미터의 목적과 작업 동작에 미치는 영향을 간결하게 설명합니다.

독립형 콘텐츠 - 설명이 외부 참조 없이 충분한 지침을 제공하는지 확인합니다.

종속성 명확성 - 설명에서 작업 간의 종속성을 명시적으로 만듭니다.

작업 참조 - API 경로가 아닌 다른 작업을 참조할 때 operationId를 사용합니다.

복잡한 객체 평면화 - 중첩된 객체 대신 별도의 파라미터(예: start_date, start_time, end_date, end_time)를 사용합니다.

표준 형식 사용 - ISO-8601 날짜 및 시간에 대해 "date-time" 또는 "date"와 같은 표준 형식 값을 사용합니다.

파라미터 이름 지우기 - 목적을 명확하게 나타내는 설명 파라미터 이름을 사용합니다.

필수 필드 표시 - API 동작에 따라 파라미터를 필수 또는 선택 사항으로 올바르게 표시합니다.

파일 크기 검증 - 사양이 1MB를 초과하지 않도록 합니다.

작업 수 검증 - 1~100개의 작업이 정의되었는지 확인합니다.

스키마 구조 검증 - 필수 필드와 적절한 형식을 확인합니다.

보안 체계 검증 - 지원되는 인증 방법을 검증합니다.

콘텐츠 유형 검증 - application/json만 사용되는지 확인합니다.

필수 필드(오파니, 정보, 서버, 경로)가 누락되었습니다.

경로 패턴 또는 작업 IDs 잘못되었습니다.

지원되지 않는 스키마 기능(배열, 구성 키워드).

설명이 누락되었거나 너무 깁니다.

스키마 정의의 순환 참조입니다.