Visual Studio Code에서 Azure API Management 정책 디버그
적용 대상: 개발자
Azure API Management에서 정책은 API 게시자가 인증, 권한 부여, 제한, 캐싱, 변환 등의 복합적인 문제를 해결하는 데 도움이 되는 강력한 기능을 제공합니다. 정책은 API의 요청이나 응답에 따라 순차적으로 실행되는 명령문의 컬렉션입니다.
이 문서에서는 Visual Studio Code에 대한 Azure API Management 확장을 사용하여 API Management 정책을 디버그하는 방법을 설명합니다.
필수 조건
먼저 이 빠른 시작을 따라 API Management Developer 계층 인스턴스를 만듭니다.
Visual Studio Code 및 최신 버전 Visual Studio Code용 Azure API Management 확장을 설치합니다.
API Management 인스턴스로 API를 가져옵니다. 예제 단계를 보려면 자습서: Visual Studio Code용 API Management 확장을 사용하여 API 가져오기 및 관리를 참조하세요.
제한 사항
- 이 기능은 디버깅에 기본 제공(서비스 수준) 모든 액세스 구독(표시 이름 "기본 제공 모든 액세스 구독")을 사용합니다.
Important
- API Management는 더 이상 추적 또는 Ocp-Apim-Trace 헤더에 대한 구독을 지원하지 않습니다.
- API 보안을 개선하기 위해 이제 API Management REST API를 사용하여 시간 제한 토큰을 가져오고 요청의 토큰을 게이트웨이에 전달하여 개별 API 수준에서 추적을 사용하도록 설정할 수 있습니다. 자세한 내용은 API 추적 사용을 참조하세요.
- 추적을 사용하도록 설정하면 추적 데이터의 중요한 정보가 노출될 수 있으므로 주의해야 합니다. 추적 데이터를 보호하기 위해 적절한 보안 조치가 마련되어 있는지 확인합니다.
디버깅 세션 시작
- Visual Studio Code 시작
- Azure 확장에서 API Management 확장으로 이동합니다.
- 디버그할 API Management 인스턴스 찾기
- 디버그할 API 및 작업 찾기
- 작업을 마우스 오른쪽 단추로 클릭하고 정책 디버깅 시작을 선택합니다.
이 시점에서 확장은 API Management 게이트웨이를 사용하여 디버깅 세션을 시작하고 설정하려고 합니다.
테스트 요청 보내기
디버깅 세션이 설정되면 확장에서 REST 클라이언트 확장을 활용하여 이 작업에 대한 테스트 HTTP 요청을 만들고 보낼 수 있게 해주는 새 편집기가 열립니다.
Ocp-Apim-Debug 헤더에 이미 요청을 추가된 것을 알 수 있습니다. 이 헤더가 필요하며, 이 값은 API Management 게이트웨이에서 디버깅 기능을 트리거하기 위해 서비스 수준, 모든 액세스 구독 키로 설정되어야 합니다.
테스트 시나리오에 따라 편집기에서 HTTP 요청을 수정합니다. 그런 다음 요청 보내기를 클릭하여 API Management 게이트웨이로 테스트 요청을 보냅니다.
디버그 정책
테스트 HTTP 요청을 보낸 후에는 확장에서 이 작업의 실제 정책이 표시되는 디버깅 창이 열리고 첫 번째 실제 정책에서 확장이 중지됩니다.
정책 파이프라인을 따르려면 개별 정책을 한 단계씩 실행하거나 정책에서 중단점을 설정하고 해당 정책에 대한 단계를 직접 수행할 수 있습니다.
변수 패널에서 시스템 생성 및 사용자 생성 변수의 값을 검사할 수 있습니다. 중단점 패널에서 설정된 모든 중단점의 목록을 볼 수 있습니다. 호출 스택 패널에서 현재 실제 정책 범위를 볼 수 있습니다.
정책을 실행하는 동안 오류가 발생하면 오류가 발생한 정책에 대하여 오류 세부 정보가 표시됩니다.
팁
완료되면 중지 단추를 클릭하여 디버그 세션을 종료해야 합니다.
다음 단계
- Visual Studio Code용 API Management 확장에 대한 자세한 정보.
- GitHub 리포지토리의 문제 보고