API 사양 업로드

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

등록된 API에 API 사양을 추가하는 방법에는 두 가지가 있습니다.

  • 사양 파일을 업로드합니다.
  • 사양 파일의 URI를 지정합니다.

API 사양 업로드

등록된 API 버전에 API 사양을 업로드하고 추가할 수 있습니다. API 사양을 업로드하면 API 허브가 사양을 파싱하고 사양에서 가져온 메타데이터로 새 API 리소스를 업데이트합니다.

이 문서에서는 API 버전에 API 사양을 추가하는 방법을 설명합니다.

API 사양 업로드

Console

  1. Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.

    API 허브로 이동
  2. API를 클릭합니다.
  3. 업데이트할 등록된 API를 선택합니다.
  4. 사양 파일 추가를 클릭합니다.
  5. 다음 방법 중 하나를 사용하여 사양 파일을 선택합니다.
    • 사양 파일 패널에서 업로드할 사양 파일을 찾아 엽니다.
    • 리소스 URL 필드에 업로드할 사양의 URL을 입력합니다.
  6. 원하는 경우 사양 이름을 추가합니다.
  7. 사양 파일을 연결할 API 버전을 선택합니다.
  8. GraphQL, REST, YAML 등의 사양 파일 유형을 선택합니다.

REST

REST API로 API 리소스를 추가하려면 다음 안내를 따르세요.

POST https://apihub.googleapis.com/v1/projects/PROJECT/locations/LOCATION/apis/ID/versions/VERSION/specs?specIdSPEC_ID

    {
      "displayName": "DISPLAYNAME",
      "contents": "SPEC_CONTENTS",
      "mimeType": "MIME_TYPE" 
    {

다음을 바꿉니다.

  • PROJECT: API 허브 호스트 프로젝트의 이름. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
  • LOCATION: 호스트 프로젝트의 위치. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
  • ID: (선택사항) ID를 제공하지 않으면 시스템에서 자동으로 생성됩니다. ID는 읽기 전용 API 리소스 이름의 마지막 구성요소이며 projects/PROJECT/locations/LOCATION/apis/ID 형식입니다.
  • VERSION: (필수) API 리소스의 버전입니다.
  • SPEC_ID: (선택사항) 사양의 ID입니다. 이 쿼리 매개변수를 제공하지 않으면 시스템에서 생성된 ID가 생성됩니다.
  • DISPLAYNAME: (필수) API 사양의 표시 이름입니다. 원하는 이름을 사용할 수 있습니다.
  • SPEC_CONTENTS: (필수) base64로 인코딩된 문자열로 구성된 사양의 콘텐츠입니다. 최대 크기는 10MB입니다. OpenAPI 사양만 지원됩니다.
  • MIME_TYPE: (필수) 콘텐츠의 MIME 유형입니다. 예를 들면 application/json, application/yaml, application/wsdl 등이 있습니다.

요청 본문에 포함하여 API에 대해 선택적인 속성을 추가하거나 나중에 추가할 수도 있습니다. 예를 들어 설명, 소유자, API 참고 리소스 링크를 지정할 수 있습니다. 자세한 내용은 API 허브 API를 참조하세요.