다음을 통해 공유

Visual Studio Code에서 Azure API Management 정책 만들기, 이해 및 디버그

적용 대상: 모든 API Management 계층

이 문서에서는 Visual Studio Code용 Azure API Management 확장을 사용하여 Azure용GitHub Copilot의 AI 지원을 통해 Azure API Management 정책을 만들고, 이해하고, 디버그하는 방법을 설명합니다.

Azure API Management 정책은 API 요청 또는 응답에 적용되는 인증, 권한 부여, 스로틀링, 캐싱 및 변환과 같은 횡단 관심사를 해결하는 일련의 지침입니다.

필수 조건

제약과 제한

  • 정책 디버깅은 현재 API Management 개발자 계층에서만 지원됩니다.

  • 정책 디버깅은 기본 제공(서비스 수준) 모든 액세스 구독을 사용합니다(표시 이름 "기본 제공 모든 액세스 구독"). 이 구독을 사용하려면 서비스 소유자여야 합니다.

Azure용 GitHub Copilot를 사용하여 정책 만들기

Azure API Management 확장은 정책 초안을 만드는 데 도움이 되도록 Azure용 GitHub Copilot와 통합됩니다. AI 지원을 통해 사용자에게 친숙한 방식으로 정책을 만들고 편집합니다.

정책을 만들려면 다음을 수행합니다.

  1. Visual Studio Code에서 API Management 확장을 엽니다.

  2. 작업할 API Management 인스턴스를 선택합니다.

  3. 작업할 정책 범위를 선택합니다.

    • 인스턴스의 모든 API에 적용되는 정책을 만들려면 전역 정책을 선택합니다.
    • 특정 API에 적용되는 정책을 만들려면 API에서 API를 선택한 다음 정책을 선택합니다.
    • 특정 API 작업에 적용되는 정책을 만들려면 작업을 선택한 다음 정책을 선택합니다.

  4. 채팅을 엽니다.

  5. 채팅 창에서 자연어로 프롬프트를 입력하여 정책을 만듭니다. 예제:

    @azure I want to limit requests to 100 calls per minute

    @azure Create a policy that sets the backend URL to https://mybackend.contoso.com and adds a custom header to the request

  6. Copilot는 채팅 창에서 정책 초안을 생성합니다. Copilot가 출력을 변경하도록 하려면 프롬프트를 구체화할 수 있습니다.

  7. 준비가 되면 복사 단추를 선택하여 정책을 클립보드에 복사하거나 편집기에서 적용 을 선택하여 편집기 창에 정책을 삽입합니다. 정책 XML의 변경 내용에 만족하는 경우 [유지]를 선택합니다.

팁

정책 XML의 문제에 대한 설명은 문제 창에서 확인하세요.

Azure용 GitHub Copilot를 사용하여 정책 설명

코파일럿은 API 관리 인스턴스에서 기존 정책을 설명하는 데 도움이 될 수 있습니다.

설명을 받으려면 다음을 수행합니다.

  1. Visual Studio Code에서 API Management 확장을 엽니다.

  2. 작업할 API Management 인스턴스를 선택합니다.

  3. 작업할 정책 범위를 선택합니다.

    • 인스턴스의 모든 API에 적용되는 정책을 설명하려면 전역 정책을 선택합니다.
    • 특정 API에 적용되는 정책을 설명하려면 API에서 API를 선택한 다음 정책을 선택합니다.
    • 특정 API 작업에 적용되는 정책을 설명하려면 작업을 선택한 다음 정책을 선택합니다.

  4. 표시되는 정책 편집기 창에서 마우스 오른쪽 단추를 클릭하고 설명을 선택합니다.

  5. 정책 XML 문서의 정책에 대한 개요 및 설명은 채팅 창에 생성됩니다.

VS Code 확장을 사용하여 정책 디버그

Visual Studio Code용 Azure API Management 확장은 정책 파이프라인을 단계별로 실행하거나 게이트웨이에 요청을 보낼 때 중단점을 설정할 수 있는 디버깅 환경을 제공합니다.

디버깅 세션 시작

  1. Visual Studio Code에서 API Management 확장을 엽니다.
  2. 디버그할 API Management 인스턴스를 선택합니다.
  3. 디버그할 API 및 작업을 선택합니다.
  4. 작업을 마우스 오른쪽 단추로 클릭하고 정책 디버깅 시작을 선택합니다.

이 시점에서 확장은 API Management 게이트웨이를 사용하여 디버깅 세션을 설정하기 시작합니다. 디버그 콘솔 창에서 진행률을 확인합니다.

Visual Studio Code에서 정책 디버깅 세션을 시작하는 경우 스크린샷

비고

디버깅 세션을 시작하면 세션 기간 동안 요청 추적을 사용하여 문제를 진단하고 해결할 수 있습니다.

테스트 요청 보내기

디버깅 세션이 설정되면 REST 클라이언트 확장은 테스트 HTTP 요청을 만들고 게이트웨이로 보낼 수 있는 새 편집기를 엽니다.

Ocp-Apim-Debug 헤더는 요청에 자동으로 추가됩니다. 이 헤더가 필요하며, 이 값은 API Management 게이트웨이에서 디버깅 기능을 트리거하기 위해 서비스 수준, 모든 액세스 구독 키로 설정되어야 합니다.

테스트 시나리오에 따라 편집기에서 HTTP 요청을 수정합니다. 그런 다음 요청 보내기 를 클릭하여 API Management 게이트웨이에 테스트 요청을 보냅니다.

Visual Studio Code에서 테스트 요청을 보내는 스크린샷

디버그 정책

테스트 HTTP 요청을 보낸 후 확장은 이 작업의 유효 정책을 표시하고 첫 번째 유효 정책에서 중지하는 디버깅 창을 엽니다.

Visual Studio Code의 디버깅 창 스크린샷

정책 파이프라인을 따르려면 개별 정책을 한 단계씩 실행하거나 정책에서 중단점을 설정하고 해당 정책에 대한 단계를 직접 수행할 수 있습니다.

  • 변수 패널에서 시스템에서 만든 변수 및 사용자가 만든 변수의 값을 검사합니다.
  • 중단점 패널에서 설정된 모든 중단점 목록을 봅니다.
  • 호출 스택 패널에서 현재 유효 정책 범위를 봅니다.

정책을 실행하는 동안 오류가 발생하면 오류가 발생한 정책에 대하여 오류 세부 정보가 표시됩니다.

완료되면 중지 단추를 클릭하여 디버깅 세션을 종료합니다.

Visual Studio Code의 정책 예외 스크린샷

팁

요청 추적을 검토하려면 HTTP 응답에 Ocp-Apim-Trace-Location 제공된 헤더 값을 선택합니다.

관련 콘텐츠

  • Last updated on