다음을 통해 공유

OpenAPI 사양 가져오기

  • 아티클

적용 대상: 모든 API Management 계층

이 문서에서는 다양한 도구를 사용하여 "OpenAPI 사양" 백 엔드 API를 Azure API Management로 가져오는 방법을 보여 줍니다. 이 문서에서는 API Management에서 API를 테스트하는 방법도 보여 줍니다.

이 문서에서는 다음 방법을 설명합니다.

  • Azure Portal, Azure CLI 또는 Azure PowerShell을 사용하여 OpenAPI 사양 가져오기
  • Azure Portal에서 API 테스트

참고 항목

API 가져오기 제한 사항은 API 가져오기 제한 사항 및 알려진 문제에 설명되어 있습니다.

필수 조건

백 엔드 API 가져오기

이 예제에서는 오픈 소스 Petstore API에 대한 OpenAPI 사양을 가져오지만 선택한 OpenAPI 사양으로 대체할 수 있습니다.

  1. Azure Portal에서 API Management 인스턴스로 이동합니다.

  2. 왼쪽 메뉴에서 API>+ API 추가를 선택합니다.

  3. 정의에서 만들기에서 OpenAPI를 선택합니다.

    포털의 OpenAPI 사양에서 API를 만드는 스크린샷.

  4. API 설정을 입력합니다. 생성 중에 값을 설정하거나 나중에 설정 탭으로 이동하여 값을 설정할 수 있습니다. 설정은 첫 번째 API 가져오기 및 게시 자습서에 설명되어 있습니다.

  5. 만들기를 실행합니다.

OpenAPI 사양 보기 및 편집

포털에서 OpenAPI 사양 편집기를 사용하여 가져온 API에 대한 사양을 확인, 유효성 검사 또는 편집합니다.

OpenAPI 사양 편집기를 사용하려면 다음을 수행합니다.

  1. Azure Portal에서 API Management 인스턴스로 이동합니다.
  2. 왼쪽 메뉴의 API 아래에서 API>>All 작업을 선택합니다.><
  3. 디자인 탭의 프런트 엔드에서 OpenAPI 사양 편집기(연필 아이콘)를 선택합니다. JSON 또는 YAML 형식으로 사양을 열 수 있습니다.
  4. 필요에 따라 사양을 검토하거나 편집합니다. 변경 내용을 저장합니다.

OpenAPI 사양 스키마에 대한 유효성 검사

OpenAPI 사양의 스키마에 대해 요청 및 응답(또는 그 요소)의 유효성을 검사하도록 API Management 유효성 검사 정책을 구성할 수 있습니다. 예를 들어, 요청 또는 응답 본문의 크기나 콘텐츠의 유효성을 검사하려면 validate-content 정책을 사용합니다.

포털에서 새 API 테스트

포털에서 직접 작업을 호출할 수 있으며, 관리자들이 이 포털을 사용해 편리한 방법으로 API의 작업을 보고 테스트할 수 있습니다.

  1. 이전 단계에서 만든 API를 선택합니다.

  2. 테스트 탭을 선택합니다.

  3. 작업을 선택합니다. 페이지에 쿼리 매개 변수에 대한 필드와 헤더 필드가 표시됩니다.

    참고 항목

    테스트 콘솔에서 API Management는 Ocp-Apim-Subscription-Key 헤더를 자동으로 채우고 기본 제공된 모든 액세스 구독의 구독 키를 구성합니다. 이 키를 사용하면 API Management 인스턴스의 모든 API에 액세스할 수 있습니다. 선택적으로 HTTP 요청 옆에 있는 "눈" 아이콘을 선택하여 Ocp-Apim-Subscription-Key 헤더를 표시합니다.

  4. 작업에 따라 쿼리 매개 변수 값, 헤더 값 또는 요청 본문을 입력합니다. 보내기를 선택합니다.

    테스트가 성공하면 백 엔드는 성공적인 HTTP 응답 코드와 일부 데이터로 응답합니다.

    팁

    기본적으로 테스트 콘솔은 API Management의 CORS 프록시에 요청을 보냅니다. 그러면 API Management 인스턴스에 요청이 전달되고, 그런 다음 백 엔드로 전달됩니다. 이 프록시는 공용 IP 주소 13.91.254.72를 사용하며 공용 엔드포인트에만 연결할 수 있습니다. 브라우저에서 API Management 서비스로 직접 요청을 보내려면 CORS 프록시 무시를 선택합니다. 테스트 콘솔을 사용하고 API Management 게이트웨이가 네트워크로 격리되어 있거나 CORS 프록시의 트래픽을 허용하지 않는 경우 이 옵션을 사용합니다.

API를 디버그하려면 자습서: 요청 추적을 사용하여 API 디버그를 참조하세요.

다른 API 추가

다음을 포함하여 다양한 서비스에 의해 노출되는 API를 구성할 수 있습니다.

  • OpenAPI 사양
  • SOAP API
  • GraphQL API
  • Azure App Service에서 호스팅되는 웹앱
  • Azure 함수 앱
  • Azure Logic Apps
  • Azure Service Fabric

다음 단계를 사용하여 기존 API에 다른 API를 추가합니다.

참고 항목

다른 API를 가져오면 작업이 현재 API에 추가됩니다.

  1. Azure Portal에서 Azure API Management 인스턴스로 이동합니다.

    포털에서 API Management 인스턴스로 이동하는 스크린샷

  2. 개요 페이지 또는 왼쪽 메뉴에서 API를 선택합니다.

    포털의 개요 페이지에서 API를 선택하는 스크린샷.

  3. 다른 API를 추가하려는 API 옆에 있는 ...를 클릭합니다.

  4. 드롭다운 메뉴에서 가져오기를 선택합니다.

    가져오기 선택

  5. API를 가져올 서비스를 선택합니다.

    포털에서 서비스를 선택하는 스크린샷

다음 단계