OpenAPI는 REST API를 설명하기 위한 사양입니다. OpenAPI 사양 2.0을 사용하면 Business Messages 및 Business Communications API의 OpenAPI 문서를 만들어 구조를 설명할 수 있습니다.
이를 통해 다음 작업을 할 수 있습니다.
- 원하는 언어로 클라이언트 라이브러리 만들기
- 서버 스텁 만들기
- API 관리 도구 사용
OpenAPI 문서의 기본 구조
OpenAPI 문서는 REST API의 노출 영역을 설명합니다. 이 문서에서는 API의 이름과 설명, API의 개별 엔드포인트 (경로), 호출자의 인증 방식 등을 정의합니다.
이 기본 구조의 예를 보려면 아래를 클릭하세요.
JSON
{
"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 문서에 액세스하려면 Business Messages 및 Business Communications API가 사용 설정된 Google Cloud Platform (GCP) 프로젝트의 API 키가 있어야 합니다.
아래 섹션을 따르세요.
- GCP 프로젝트 만들기
- API 키 만들기
- Business Messages API 및 Business Communications API 사용 설정
이 단계를 완료하면 OpenAPI 문서에 액세스할 수 있습니다.
GCP 프로젝트 만들기
이미 GCP 프로젝트가 있다면 해당 프로젝트를 사용하여 API 키를 만들 수 있습니다.
새 GCP 프로젝트를 만들려면 다음 단계를 따르세요.
- GCP Console에서 리소스 관리 페이지로 이동합니다.
- 페이지 상단의 조직 선택 드롭다운 목록에서 프로젝트를 만들려는 조직을 선택합니다. 무료 체험판 사용자인 경우 이 단계를 건너뛰세요.
- 프로젝트 만들기를 클릭합니다.
- New Project 창에서 프로젝트 이름을 입력하고 해당하는 결제 계정을 선택합니다. 프로젝트 이름에는 문자, 숫자, 작은따옴표, 하이픈, 공백 또는 느낌표만 사용할 수 있으며 4~30자(영문 기준)여야 합니다.
위치에 새 프로젝트의 상위 조직 또는 폴더를 입력합니다.
만들기를 클릭합니다.
API 키 만들기
GCP Console에서 사용자 인증 정보 페이지로 이동합니다.
사용자 인증 정보 만들기를 클릭하고 API 키를 선택합니다.
API 키 생성 대화상자에 새로 생성된 키가 표시됩니다. 키를 복사하여 안전하게 보관합니다. API 키에 대한 자세한 내용은 API 키 문서를 참조하세요.
Business Communications API 및 Business Messages API 사용 설정
GCP 프로젝트에서 이러한 API를 사용 설정하려면 다음 단계를 따르세요.
- GCP Console에서 API 및 서비스 페이지로 이동합니다.
- 프로젝트 선택 드롭다운 목록에서 API를 사용 설정할 프로젝트를 선택합니다.
- API 및 서비스 사용 설정을 클릭합니다.
- API 및 서비스 검색 필드에 Business Messages를 입력합니다.
- Business Messages API를 선택합니다.
- 사용 설정을 클릭합니다.
- API 및 서비스 사용 설정을 클릭합니다.
- API 및 서비스 검색 필드에 비즈니스 커뮤니케이션을 입력합니다.
- Business Communications API를 선택합니다.
- 사용 설정을 클릭합니다.
이제 API 키에 Business Messages 및 Business Communications API의 OpenAPI 문서에 액세스할 수 있는 권한이 있습니다.
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 키로 바꿉니다.