API 사양 소개

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

API 사양 정보

API 사양은 표준 형식을 사용하여 API를 설명합니다. 머신에서 읽을 수 있지만 사람도 쉽게 읽고 이해할 수 있습니다. 사양은 일반적으로 그림 1에 표시된 것처럼 기본 경로, 경로 및 동사, 헤더, 쿼리 매개변수, 작업, 콘텐츠 유형, 응답 설명 등과 같은 API 요소를 설명합니다.

API 버전에는 OpenAPI 사양, Proto, WSDL과 같이 동일하거나 다른 유형의 여러 API 사양이 포함될 수 있습니다. 지원되는 경우 API 허브가 API 사양을 파싱하여 API ID, 버전 ID, 설명, 작업과 같은 API 메타데이터를 추출하고 저장할 수 있습니다. 사양 파싱을 참조하세요.

API 허브에 API 사양 사용

API 사양 유무에 관계없이 API 허브에서 API 버전을 만들 수 있습니다.

버전을 만들 때 사양을 업로드할 수 있습니다. 사용자 인터페이스에서 API 세부정보를 보면 API 리소스의 버전과 관련된 모든 사양 목록이 표시됩니다.

REST API를 사용하여 사양으로 버전을 만들고 구성할 수도 있습니다. API를 사용할 때는 사양으로 API 버전 항목을 만든 후 버전을 API 리소스에 연결합니다.

자세한 내용은 버전에 사양 추가를 참조하세요.

사양 파싱

지원되는 경우 API 허브는 API 사양을 파싱하여 API에 대한 정보를 추출하고 API 버전과 함께 저장할 수 있습니다. 예를 들어 API 허브는 API OpenAPI 사양을 파싱하여 API ID, 버전 ID, 설명, 작업, 기타 메타데이터를 추출하고 저장할 수 있습니다.

API 허브는 사양 유효성 검사도 지원합니다. API 사양 유효성 검사를 참조하세요.