자습서: API 인벤토리에 API 등록

이 자습서에서는 Azure Portal을 사용하여 API를 등록하고 메타데이터를 할당하여 조직의 API 센터에서 API 인벤토리를 시작하는 방법을 설명합니다.

Azure API 센터에서 인벤토리할 수 있는 API, API 버전, 정의 및 기타 엔터티에 대한 자세한 내용은 주요 개념을 참조하세요.

이 자습서에서는 Azure Portal을 사용하여 다음을 수행하도록 하는 방법을 알아봅니다.

• API를 하나 이상 등록
• API 정의를 사용하여 API 버전 추가

필수 조건

• Azure 구독의 API 센터입니다. 만들려면 빠른 시작: API 센터 만들기를 참조하세요.

• API 센터에 등록하려는 API가 하나 이상. 다음은 OpenAPI 정의에 대한 링크가 포함된 두 가지 예입니다.

  • Swagger Petstore API
  • 회의 API

• 이전 자습서 사용자 지정 메타데이터 정의를 완료하여 API에 대한 사용자 지정 메타데이터를 정의하십시오.

API 등록

API 센터에 API를 등록(추가)하면 API 등록에는 다음이 포함됩니다.

• 제목(이름), 형식 및 설명
• 버전 정보
• 문서 및 연락처에 대한 선택적 링크
• 사용자가 정의한 기본 제공 및 사용자 지정 메타데이터

API를 등록한 후 API에 버전과 정의를 추가할 수 있습니다.

다음 단계에서는 Swagger Petstore API 및 Conference API의 두 가지 샘플 API를 등록합니다(필수 구성 요소 참조). 원하는 경우 자체 API를 등록합니다.

1. Azure Portal에 로그인한 다음, API 센터로 이동합니다.

2. 사이드바 메뉴의 자산 아래에서 API>+ API 등록을 선택합니다.

3. API 등록 페이지에서 Swagger Petstore API의 다음 정보를 추가합니다. 페이지 맨 아래에서 이전 자습서에서 정의한 사용자 지정 업무 영역 및 대외 메타데이터를 볼 수 있습니다.

   Setting	가치	Description
   API 제목	Swagger Petstore API를 입력합니다.	API에 대해 선택한 이름
   ID	이전 제목을 입력하면 Azure API 센터에서 재정의할 수 있는 이 식별자를 생성합니다.	API의 Azure 리소스 이름
   API 형식	드롭다운에서 REST를 선택합니다.	API 유형
   요약	필요한 경우 요약을 입력합니다.	API에 대한 요약 설명
   설명	선택적으로 설명을 입력합니다.	API에 대한 설명
   버전
   버전 제목	원하는 버전 제목을 입력합니다(예: v1).	API 버전에 대해 선택한 이름
   버전 식별	이전 제목을 입력하면 Azure API 센터에서 재정의할 수 있는 이 식별자를 생성합니다.	버전의 Azure 리소스 이름
   버전 수명 주기	드롭다운에서 선택합니다(예: 테스트 또는 프로덕션).	API 버전의 수명 주기 단계
   외부 문서	필요한 경우 외부 문서에 링크를 하나 이상 추가합니다.	API에 대한 설명서의 이름, 설명 및 URL
   라이선스	선택적으로 라이선스 정보를 추가합니다.	API에 대한 라이선스의 이름, URL 및 ID
   연락처 정보	필요한 경우 연락처 하나 이상에 대한 정보를 추가합니다.	API에 대한 연락처의 이름, 전자 메일 및 URL
   사업 부문	이전 자습서에서 이 메타데이터를 추가한 경우 드롭다운에서 마케팅과 같은 항목을 선택합니다.	API를 소유하는 사업부를 식별하는 사용자 지정 메타데이터
   공용	이 메타데이터를 추가한 경우 확인란을 선택합니다.	API가 공용 또는 내부 전용인지 여부를 식별하는 사용자 지정 메타데이터

   

4. 만들기를 선택하여 API를 등록합니다.

5. 위의 세 단계를 반복하여 Conference API와 같은 다른 API를 등록합니다.

팁 (조언)

Azure Portal에서 API를 등록할 때 미리 정의된 API 유형을 선택하거나 원하는 다른 형식을 입력할 수 있습니다.

API는 포털의 API 페이지에 표시됩니다. API 센터에 많은 수의 API를 추가하는 경우 이 페이지의 검색 상자와 필터를 사용하여 원하는 API를 찾습니다.

API를 등록한 후 API 속성을 보거나 편집할 수 있습니다. API 페이지에서 API를 선택하면 API 등록을 관리하는 페이지가 표시됩니다.

API 버전 추가

수명 주기 내내 API에는 여러 버전이 있을 수 있습니다. 필요한 경우 정의 파일을 사용하여 API 센터에서 기존 API에 버전을 추가할 수 있습니다.

여기서는 API 중 하나에 버전을 추가합니다.

1. Azure Portal에서 API 센터로 이동합니다.

2. 사이드바 메뉴에서 API를 선택한 다음 API(예: Swagger Petstore)를 선택합니다.

3. API 페이지의 세부 정보 아래에서 버전>+ 버전 추가를 선택합니다.

   

4. API 버전 추가 페이지에서 버전 세부 정보에서 다음 정보를 입력하거나 선택합니다.

   Setting	가치	Description
   버전 제목	원하는 버전 제목을 입력합니다(예: v2).	API 버전에 대해 선택한 이름
   버전 식별	이전 제목을 입력하면 Azure API 센터에서 재정의할 수 있는 이 식별자를 생성합니다.	버전의 Azure 리소스 이름
   버전 수명 주기	드롭다운에서 선택합니다(예: 프로덕션).	API 버전의 수명 주기 단계

5. Azure API 센터는 REST API용 OpenAPI 2 및 3과 같은 일반적인 텍스트 사양 형식의 정의를 지원합니다. API 정의를 추가하려면 사양 선택에서 다음 정보를 입력하거나 선택합니다.

   Setting	가치	Description
   정의 제목	v2 정의와 같이 원하는 제목을 입력합니다.	API 정의에 대해 선택한 이름
   정의 식별	이전 제목을 입력하면 Azure API 센터에서 재정의할 수 있는 이 식별자를 생성합니다.	정의에 대한 Azure 리소스 이름
   설명	선택적으로 설명을 입력합니다.	API 정의에 대한 설명
   사양 형식	Petstore API의 경우 OpenAPI를 선택합니다.	API에 대한 사양 형식
   사양 버전	원하는 버전 식별자를 입력합니다(예: 3.0).	사양 버전
   파일 또는 URL	Petstore API에 대한 로컬 정의 파일로 이동하거나 URL을 입력합니다. URL 예: https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yaml	API 정의 파일

   

6. 선택하고생성합니다.

API 인벤토리를 빌드할 때 Visual Studio Code용 Azure API 센터 확장 및 Azure CLI와 같은 자동화된 도구를 활용하여 API를 등록합니다.

다음 단계

API 인벤토리가 구체화되고 있습니다. 이제 API 환경과 배포에 대한 정보를 추가할 수 있습니다.

API 환경 및 배포 추가