API 게이트웨이 호환 모드
마지막 업데이트: 2026. 10. 20.API Contracts는 사용자가 정의를 AWS API Gateway 및 Azure API Management로 가져올 수 있도록 지원하는 API 게이트웨이 호환 모드를 제공합니다.
게이트웨이 호환 모드에서 API를 내보낼 때, 선택한 게이트웨이로 성공적으로 가져올 수 있도록 API Contracts에서 정의를 수정할 수 있습니다.
경우에 따라 변경 사항은 없지만, 내보낸 정의에서 발생할 수 있는 호환성 문제를 알리는 메시지가 표시될 수 있습니다.
AWS API Gateway용 OAS 3.0 정의 내보내기
다음 표에서는 정의를 내보낼 때 API Contracts에서 AWS API Gateway가 지원하지 않는 기능을 처리하는 방법과, 정의를 가져올 때 AWS API Gateway에서 일어나는 동작에 대해 설명합니다.
| 지원되지 않는 OpenAPI 기능 | API 계약 내보내기 시 동작 | 가져오기 시 AWS API Gateway 동작 |
|---|---|---|
| example 속성은 지원되지 않습니다. | 속성이 유지됩니다. | 해당 속성이 스키마에서 제거됩니다. |
| readOnly 속성은 지원되지 않습니다. | 속성이 유지됩니다. | 해당 속성이 스키마에서 제거됩니다. |
| additionalProperties 속성은 지원되지 않습니다. | 속성이 보존되고 정보 메시지가 표시됩니다. | 경고 메시지가 표시되지만 무시할 수 있으며, 정의를 성공적으로 가져올 수 있습니다. |
보안 정의 유형:
|
보안 체계가 유지되고 안내 메시지가 표시됩니다. | 경고 메시지가 표시되지만 무시할 수 있으며, 정의를 성공적으로 가져올 수 있습니다. |
| 응답의 기본 데이터 유형은 지원되지 않습니다. | 원시 타입이 컴포넌트 스키마로 래핑되고 경고 메시지가 표시됩니다. | 가져오기가 성공합니다. |
| 미디어 유형 범위는 지원되지 않습니다. | 요청 또는 응답이 보존되고 정보 메시지가 표시됩니다. | 가져오기에 실패하고 경고 메시지가 표시됩니다. |
| 기본 응답은 지원되지 않습니다. | 응답이 보존되고 정보 메시지가 표시됩니다. | 가져오기에 실패하고 경고 메시지가 표시됩니다. |
| 범위 응답은 지원되지 않습니다. | 응답이 보존되고 정보 메시지가 표시됩니다. | 가져오기에 실패하고 경고 메시지가 표시됩니다. |
| 경로 변수, 쿼리 매개변수 및 헤더는 고유한 이름을 가져야 합니다. | 매개변수가 유지되고 오류 메시지가 표시됩니다. | 가져오기가 실패합니다. |
Azure API Management용 OAS/Swagger 2.0 정의 내보내기
다음 표에서는 정의를 내보낼 때 Azure API Management에서 지원하지 않는 기능을 API Contracts에서 처리하는 방법과, 정의를 가져올 때 Azure API Management에서 발생하는 상황을 설명합니다.
| 지원되지 않는 OpenAPI 기능 | API 계약 내보내기 시 동작 | 가져오기 시 Azure API Management 동작 |
|---|---|---|
| 경로와 쿼리 모두에서 필수 매개변수의 이름은 고유해야 합니다. | 오류 메시지가 표시됩니다. | 가져오기가 실패합니다. |