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

  • 아티클

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

API 센터에서 목록화할 수 있는 Azure API, API 버전, 정의 및 기타 엔터티에 대한 배경 지식은 주요 개념을 참조하세요.

이 자습서에서는 포털을 사용하여 다음을 수행하는 방법을 알아봅니다.

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

필수 조건

API 등록

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

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

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

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

  1. 포털에서 API 센터로 이동합니다.

  2. 왼쪽 메뉴의 자산에서 API>+ API 등록을 선택합니다.

  3. API 등록 페이지에서 Swagger Petstore API의 다음 정보를 추가합니다. 페이지 하단에서 이전 자습서에서 정의한 사용자 지정 사업 부문 및 공용 메타데이터를 볼 수 있습니다.

    설정 값 설명
    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가 공용인지 내부 전용인지 식별하는 사용자 지정 메타데이터입니다.

    포털에 API를 등록하는 스크린샷.

  4. 만들기를 실행합니다. API가 등록됩니다.

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

팁

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

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

포털의 API 페이지 스크린샷.

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

API 버전 추가

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

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

  1. 포털에서 API 센터로 이동합니다.

  2. 왼쪽 메뉴에서 API를 선택한 다음, API를 선택합니다(예: 데모 회의 API).

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

    포털에 API 버전을 추가하는 스크린샷.

  4. API 버전 추가 페이지에서 다음을 수행합니다.

    1. 다음 정보를 입력하거나 선택합니다.

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

    2. 만들기를 실행합니다. 버전이 추가됩니다.

버전에 정의 추가

일반적으로 API 버전에 API 정의를 추가하려고 합니다. Azure API 센터는 REST API용 OpenAPI 2 및 3과 같은 일반적인 텍스트 사양 형식의 정의를 지원합니다.

버전에 API 정의를 추가하려면 다음을 수행합니다.

  1. API의 버전 페이지에서 API 버전을 선택합니다.

  2. API 버전 왼쪽 메뉴의 세부 정보에서 정의>+ 정의 추가를 선택합니다.

  3. 정의 추가 페이지에서 다음을 수행합니다.

    1. 다음 정보를 입력하거나 선택합니다.

      설정 값 설명
      제목 v2 정의와 같이 원하는 제목을 입력합니다. API 정의에 선택한 이름입니다.
      ID 이전 제목을 입력하면 Azure API 센터에서 재정의할 수 있는 이 식별자를 생성합니다. 정의의 Azure 리소스 이름입니다.
      설명 선택적으로 설명을 입력합니다. API 정의에 대한 설명입니다.
      사양 이름 데모 회의 API의 경우 OpenAPI를 선택합니다. API의 사양 형식입니다.
      사양 버전 원하는 버전 식별자를 입력합니다(예: 2.0). 사양 버전입니다.
      Document 데모 회의 API에 대한 로컬 정의 파일을 찾아보거나 URL을 입력합니다. URL 예: https://conferenceapi.azurewebsites.net?format=json API 정의 파일입니다.

      포털에 API 정의를 추가하는 스크린샷.

    2. 만들기를 실행합니다. 정의가 추가됩니다.

이 자습서에서는 포털을 사용하여 다음을 수행하는 방법을 알아보았습니다.

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

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

다음 단계

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

API 환경 및 배포 추가