OpenAPI

OpenAPI는 REST API를 설명하기 위한 사양입니다. 사용 OpenAPI 사양 2.0 Business Messages 및 Business를 위한 OpenAPI 문서를 Communications API를 사용해 구조를 설명합니다.

이를 통해 다음 작업을 할 수 있습니다.

  • 원하는 언어로 클라이언트 라이브러리 만들기
  • 서버 스텁 만들기
  • API 관리 도구 사용

OpenAPI 문서의 기본 구조

OpenAPI 문서는 REST API의 노출 영역을 설명합니다. 이 문서에서는 API의 이름 및 설명, API, 호출자 인증 방법 등이 포함됩니다.

이 기본 구조의 예를 보려면 아래를 클릭하세요.

    {
      "swagger": "2.0",
      "host": "businessmessages.googleapis.com",
      "info": {
        "title": "Business Messages API",
        "description": "",
        "version": "v1"
      },
      "paths": {
        "/v1/conversations/{conversationsId}/messages": {
          "post": {
            "description": "Sends a message from an agent to a user.",
            "parameters": [
              {
                "description": "Part of `parent`. Required. The conversation that contains the message. Resolves to \"conversations/{conversationId}\".",
                "type": "string",
                "in": "path",
                "required": true,
                "name": "conversationsId"
              },
              {
                "description": "Optional. A flag to send the specified fallback text instead of other message content.",
                "name": "forceFallback",
                "type": "boolean",
                "in": "query"
              },
              {
                "name": "message",
                "schema": {
                  "$ref": "#/definitions/BusinessMessagesMessage"
                },
                "in": "body",
                "description": "Required. The content of a message."
              }
            ],
            "tags": [
              "businessmessages"
            ],
            "operationId": "CreateMessage",
            "responses": {
              "default": {
                "schema": {
                  "$ref": "#/definitions/BusinessMessagesMessage"
                },
                "description": "Successful operation"
              }
            }
          }
        }
      }
    }

OpenAPI 문서의 구조에 대한 자세한 내용은 Swagger 웹사이트

OpenAPI 문서에 액세스하는 방법

OpenAPI 문서에 액세스하려면 Google Cloud의 API 키가 있어야 합니다. 비즈니스 메시지 및 비즈니스 커뮤니케이션이 포함된 플랫폼 (GCP) 프로젝트 API가 사용 설정되었습니다.

아래 섹션을 따라 하세요.

  • GCP 프로젝트 만들기
  • API 키 만들기
  • Business Messages API 및 Business Communications API 사용 설정

이 단계를 완료하면 OpenAPI 문서에 액세스할 수 있습니다.

GCP 프로젝트 만들기

GCP 프로젝트가 이미 있으면 이를 사용하여 API 키를 생성할 수 있습니다.

새 GCP 프로젝트를 만들려면 다음 안내를 따르세요.

  1. 리소스 관리로 이동합니다. 페이지로 이동합니다.
  2. 페이지 상단의 조직 선택 드롭다운 목록에서 프로젝트를 만들 조직을 선택합니다. 무료 체험판 사용자는 이 단계를 건너뛰세요.
  3. 프로젝트 만들기를 클릭합니다.
  4. New Project 창에서 프로젝트 이름을 입력하고 새 결제 계정을 만들 수 있습니다 프로젝트 이름에는 문자, 숫자, 하나의 문자만 사용할 수 있습니다. 따옴표, 하이픈, 공백, 느낌표 등을 사용할 수 있으며 4~30자(영문 기준)여야 합니다.

  5. 위치에 새 프로젝트의 상위 조직 또는 폴더를 입력합니다.

  6. 만들기를 클릭합니다.

API 키 만들기

  1. 다음으로 이동합니다. 사용자 인증 정보 페이지 확인할 수 있습니다

  2. 사용자 인증 정보 만들기를 클릭하고 API 키를 선택합니다.

    API 키 생성 대화상자에 새로 생성된 키가 표시됩니다. 키를 복사하여 안전하게 보관하세요. API 키에 대해 자세히 알아보려면 API 키 문서

Business Communications API 및 Business Messages API 사용 설정

GCP 프로젝트에서 이러한 API를 사용 설정하려면 다음을 수행합니다.

  1. API 및 서비스 페이지로 이동합니다.
  2. 프로젝트 선택 드롭다운 목록에서 선택합니다.
  3. API 및 서비스 사용 설정을 클릭합니다.
  4. API 및 서비스 검색 필드에 Business Messages를 입력합니다.
  5. Business Messages API를 선택합니다.
  6. 사용 설정을 클릭합니다.
  7. API 및 서비스 사용 설정을 클릭합니다.
  8. API 및 서비스 검색 입력란에 비즈니스 커뮤니케이션을 입력합니다.
  9. Business Communications API를 선택합니다.
  10. 사용 설정을 클릭합니다.

이제 API 키에 Business Messages 및 Business Communications API

OpenAPI 문서에 액세스

다음 명령어를 실행하여 Business Messages API용 OpenAPI 문서에 액세스합니다. 

curl "https://businessmessages.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"

다음 명령어를 실행하여 Business Communications API용 OpenAPI 문서에 액세스합니다. 

curl "https://businesscommunications.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"

API_KEY를 API 키로 바꿉니다.