curl 및 Visual Studio Code를 사용하여 Microsoft Learn 카탈로그 API 시작하기
이 문서는 curl 및 Visual Studio Code를 사용하여 Microsoft Learn 카탈로그 API 사용을 시작하는 데 도움이 됩니다. API의 세부 정보나 사용 사례에 익숙하지 않다면 먼저 Learn 카탈로그 API 기능 개요 문서를 검토하는 것이 좋습니다.
살펴볼 개략적인 프로세스는 다음과 같습니다.
- Learn 카탈로그 API 쿼리
- 초기 응답 검토
- 응답 “꾸미기”
- 스프레드시트로 변환
- 더 많은 쿼리 사용해 보기
Learn 카탈로그 API를 사용하기 시작하면 사용자 고유의 요구에 맞게 원하는 도구 세트나 요구 사항 단계를 약간 수정할 수 있지만 일반적으로 이 API를 사용하는 프로세스는 모든 사용 사례에서 동일합니다.
사전 요구 사항
이 문서의 단계를 수행하려면 API를 쿼리하기 위한 인기 있는 두 가지 무료 도구인 curl과 Visual Studio Code가 필요합니다.
- curl과 Visual Studio Code가 이미 설치된 경우 Learn 카탈로그 API 쿼리 섹션으로 건너뛸 수 있습니다.
- 설치되지 않은 경우 다음 섹션의 지침을 따릅니다.
curl 다운로드 및 설정
curl은 널리 쓰는 무료 오픈 소스 명령줄 도구로 API를 쿼리할 수 있습니다.
- curl 다운로드 페이지로 이동하여 환경에 적합한 패키지를 다운로드합니다. 어떤 항목을 선택해야 할지 모르는 경우 curl 다운로드 마법사를 사용합니다.
- 애플리케이션을 설치하고 메시지에 따라 구성합니다. 이 문서나 Learn 카탈로그 API를 쿼리하는 데 필요한 고유한 설정은 없습니다.
Visual Studio Code 다운로드 및 설정
Visual Studio Code는 Microsoft에서 개발한 무료 코드 편집기로 성능이 뛰어납니다.
- Visual Studio Code 사이트로 이동하여 환경에 적합한 패키지를 다운로드합니다.
- 애플리케이션을 설치하고 메시지에 따라 구성합니다.
Learn 카탈로그 API 쿼리
Learn 카탈로그 API를 사용하는 데 필요한 인증이 없으므로 curl을 사용할 수 있는 명령줄에서 API 엔드포인트를 쿼리할 수 있습니다. 이 연습에서는 Visual Studio Code 내에서 터미널을 사용합니다.
- Visual Studio Code를 엽니다.
- 위쪽 탐색 영역에서 터미널을 선택합니다.
- 새 터미널을 선택하여 새 명령 터미널을 엽니다.
- 사용할 터미널(Bash, CMD 등)을 선택하고 아래 명령을 입력합니다. 아래 명령은 curl을 사용하고 필터링되지 않은 Learn 카탈로그 API 엔드포인트를 호출하고 터미널에 표시된 파일 경로에 정의된 위치에 “output.json”이라는 파일에 응답을 출력한다는 것을 나타냅니다(예:
C:\Users\<username>
).
curl https://learn.microsoft.com/api/catalog >> output.json
- 요청이 성공한 경우 파일의 총 크기(예: 13.1M)에 대한 정보가 표시됩니다(응답 크기에 따라 크기가 변경될 수 있음). 실패하면 오류가 발생합니다.
참고
output.json 파일을 사용한 후 삭제하거나 더 적합한 이름으로 바꿔야 합니다. 동일한 파일 이름을 사용하여 API를 다시 쿼리하면 기존 파일 내에 응답이 추가됩니다. 또 다른 옵션은 “output-1212.json” 또는 “output-de-de-2022-12-12.json”과 같은 초기 쿼리 명령 중에 파일의 이름을 더욱 고유하게 지정하는 것입니다.
초기 응답 검토
초기 응답은 JSON에 있으며 “최소화”됩니다. 즉, 파일을 더 작게 만들기 위해 특정 공백, 줄, 탭이 제거됩니다.
- Visual Studio Code에서 파일을 선택합니다.
- 폴더 열기를 선택합니다.
- 이전 섹션의 일부로 만든 “output.json” 파일로 이동합니다.
이 최소화는 표준 사례이며 다음 섹션에서 수행할 Visual Studio Code 명령으로 파일을 더 읽기 쉽게 “꾸밀” 수 있습니다.
응답 꾸미기
- Visual Studio Code에서 “output.json” 파일을 연 상태에서 Ctrl+Shift+I를 사용합니다.
JSON이 여러 줄로 분할되고 더 읽기 쉬운 형식으로 업데이트되어야 합니다. 응답 내의 다양한 속성과 값에 대한 자세한 내용은 데이터 사전에 대한 Learn 카탈로그 API 개발자 참조 문서를 참조하세요.
응답을 스프레드시트로 변환
시스템에 통합하는 대신 개별 작업을 하거나 검토할 때 Learn 카탈로그 API를 사용하는 사람들이 많습니다. 이러한 사용 사례의 경우 JSON 응답을 CSV 또는 Excel 형식으로 변환하여 스프레드시트로 보는 것이 편리할 수 있습니다. 원하는 변환 도구를 사용할 수 있지만 여기서는 Flatfile Json to CSV 변환기를 사용할 수 있습니다.
- https://csvjson.com/json2csv로 이동합니다.
- 출력 파일을 업로드합니다.
- 변환을 선택합니다.
- 다운로드를 선택합니다.
참고
외부 온라인 도구를 사용하여 데이터를 변환하고 어떤 데이터를 입력할지 고려할 때는 신중해야 합니다. Learn 카탈로그 API의 경우 응답을 공개적으로 사용할 수 있으며 인증이 필요하지 않으므로 온라인 도구를 사용하여 형식을 변환하는 것이 좋습니다.
더 많은 쿼리 사용해 보기
위의 단계에 따라 아래에 나열된 쿼리와 같은 더 많은 쿼리를 시도합니다. 각각에 대한 응답 파일 크기 변경 방식과 내부 개체의 차이를 확인합니다.
Description | 쿼리 |
---|---|
Learn 카탈로그 API의 모든 항목 | https://learn.microsoft.com/api/catalog/ |
모든 스페인어 모듈 | https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules |
인기 점수가 0.9 이상인 모든 모듈 | https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9 |
모든 초급 보안 교육과 인증 개체 | https://learn.microsoft.com/api/catalog/?level=beginner&subject=security |
인기 점수가 0.5를 초과하고 지난 한 달간 업데이트된 모든 고급 접근성 모듈 | https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01 |
다음 단계
개발 경험을 풍부하게 하려면 아래 리소스를 검토하는 것이 좋습니다.