Apidog에서 gRPC 요청을 보내는 방법은 무엇입니까?

gRPC는 다양한 시나리오에서 널리 사용되는 효율적이고 빠르며 신뢰할 수 있는 Remote Procedure Call(RPC) 프레임워크입니다. 마이크로서비스 아키텍처에서 Apidog는 서비스 간 효율적인 통신을 지원합니다. 대규모 데이터 전송이 필요한 시나리오의 경우, Apidog는 스트리밍 기능을 활용하여 네트워크 지연 시간과 대역폭 소비를 줄입니다.

gRPC API 디버깅 기능은 현재 베타 테스트 단계에 있습니다. gRPC API 디버깅 기능을 사용하려면 Apidog 버전이 2.3.0 이상이어야 합니다.

새 gRPC 프로젝트 생성

Apidog 홈페이지에서 "New Project" 버튼을 클릭하고 "gRPC Project (Beta)"를 선택하십시오.

Proto 가져오기

gRPC는 API-First 접근 방식을 따르므로, 개발 전에 서비스, 메서드 및 메시지를 .proto 파일을 통해 정의해야 합니다. 따라서 Apidog를 사용하여 gRPC API를 디버깅하기 전에 API 정의 역할을 하는 .proto 파일을 가져와야 합니다.

최초 가져오기

현재 .proto 파일을 가져오는 방법은 두 가지가 있습니다.

로컬 파일

.proto 파일을 호스팅하는 URL

선택한 .proto 파일은 하나의 Proto로 가져오며, service는 서비스로 가져오고 rpc는 메서드로 가져옵니다.

선택한 .proto 파일이 다른 .proto 파일에 의존하는 경우, 종속성 디렉터리를 수동으로 추가해야 합니다.

선택한 .proto 파일이 의존하는 다른 .proto 파일의 서비스도 해당 패키지가 선택한 .proto 파일과 동일한 패키지에 속하는 경우 동일한 Proto로 가져옵니다.

다시 가져오기

가져온 .proto 파일이 변경된 경우 Apidog에서 다시 가져올 수 있습니다. Proto를 마우스 오른쪽 버튼으로 클릭한 다음 "Reimport" 버튼을 클릭하십시오.

호출 방식

.proto 파일을 사용하여 gRPC 메서드를 정의할 때 Apidog는 네 가지 유형을 지원합니다.

Unary: 단방향 호출

Server Streaming: 서버 측 스트리밍

Client Streaming: 클라이언트 측 스트리밍

Bidirectional Streaming: 양방향 스트리밍

Apidog는 네 가지 메서드 유형을 모두 지원합니다.

Unary 호출

Unary 호출은 HTTP 요청과 유사합니다. 주소 표시줄에 URL을 입력하고, Message 탭에서 JSON 형식으로 메시지 내용을 입력한 후 "Invoke" 버튼을 클릭하면 Unary 호출이 시작됩니다.

또한 인증 또는 기타 복잡한 시나리오를 충족하기 위해 Metadata 및 Auth 정보를 수동으로 입력할 수 있습니다.

스트리밍 호출

스트리밍 호출은 WebSocket 연결과 유사합니다. 호출을 시작한 후 Message 탭에서 메시지를 작성하고 보낼 수 있습니다. 서버 스트리밍, 클라이언트 스트리밍 및 양방향 스트리밍은 스트리밍 호출 유형에 속합니다.

Apidog는 호출 상태, 전송된 메시지 및 수신된 메시지를 시간순으로 중앙에 표시하는 타임라인 보기를 제공합니다. 메시지를 클릭하면 메시지 세부 정보를 쉽게 확인할 수 있습니다.

고급 사용법

동적 값 자동 생성

Apidog는 .proto 파일의 내용을 인식할 수 있으므로, "Auto-generate" 버튼을 클릭하여 메시지 본문을 생성할 수 있습니다. 더 유연한 동적 데이터를 위해 "Dynamic Values" 기능을 사용하여 표현식을 구성하고 생성할 수 있습니다.

자세한 지침은 *"Dynamic Values"*를 참조하십시오.

변수 사용

gRPC 메시지 및 Metadata에서 Apidog 변수를 사용할 수 있습니다. 자세한 지침은 "Environment Variable Types" 문서를 참조하십시오.

TLS 활성화

gRPC API는 TLS를 통한 보안 연결 설정을 지원합니다.

Apidog를 사용하면 URL 앞의 프로토콜 선택기를 클릭하여 TLS 상태를 빠르게 전환할 수 있습니다.

또한 Apidog는 연결에 TLS를 활성화하기 위해 URL에서 grpcs://를 사용하는 것과 호환됩니다. 반대로 grpc://는 TLS가 활성화되지 않았음을 나타냅니다.

서버 주소 및 환경 관리

URL 주소 표시줄 오른쪽의 더하기 아이콘을 클릭하여 현재 사용 중인 서버 주소를 환경에 추가하십시오.

그런 다음 오른쪽 상단에서 환경과 서버 주소를 선택하고, URL 주소 표시줄에서 "Follow Default"를 선택하여 모든 메서드를 디버깅할 때 통합된 서버 주소를 사용하십시오.

Proto 파일 및 API 매개변수 보기

Proto 파일 내용 보기

Apidog에서 왼쪽 디렉터리 트리의 Proto를 클릭하면 .proto 파일의 원본 내용을 볼 수 있습니다.

요청 및 응답 매개변수 보기

gRPC는 직렬화 형식으로 ProtoBuf를 사용합니다. 즉, 메시지를 보내거나 받을 때 각 메시지가 ProtoBuf 형식으로 전송됩니다. 다른 텍스트 기반 직렬화 형식(JSON, XML)과 달리 ProtoBuf는 사람이 작성하고 읽기에 적합하지 않은 바이너리 형식입니다. 따라서 Apidog에서 gRPC API를 호출할 때 모든 메시지는 JSON 형식으로 작성되고 표시됩니다.

API 정보 페이지에서 JSON 형식으로 표현된 요청 및 응답 매개변수를 볼 수 있습니다.

ProtoBuf와 JSON은 아래 표와 같이 데이터 유형에 대한 매핑 관계를 갖습니다.

ProtoBuf 3	JSON	JSON 예시
message	object	`{"fooBar": v, "g": null, …}`
enum	string	`"FOO_BAR"`
map<K,V>	object	`{"k": v, …}`
repeated V	array	`[v, …]`
bool	boolean	`true, false`
string	string	`"Hello World!"`
bytes	base64 string	`"YWJjMTIzIT8kKiYoKSctPUB+"`
int32, fixed32, uint32	number	`1, -10, 0`
int64, fixed64, uint64	string	`"1", "-10"`
float, double	number	`1.1, -10.0, 0, "NaN", "Infinity"`

디버깅 정보 저장

디버깅을 완료한 후 "Save" 버튼을 클릭하여 현재 메서드의 서버 URL, 메시지, Metadata 등을 저장하면 다른 팀 구성원이 디버깅에 사용할 수 있습니다.

Apidog에서 gRPC 요청을 보내는 방법은 무엇입니까?

새 gRPC 프로젝트 생성#

Proto 가져오기#

최초 가져오기#

다시 가져오기#

호출 방식#

Unary 호출#

스트리밍 호출#

고급 사용법#

동적 값 자동 생성#

변수 사용#

TLS 활성화#

서버 주소 및 환경 관리#

Proto 파일 및 API 매개변수 보기#

Proto 파일 내용 보기#

요청 및 응답 매개변수 보기#

디버깅 정보 저장#

새 gRPC 프로젝트 생성

Proto 가져오기

최초 가져오기

다시 가져오기

호출 방식

Unary 호출

스트리밍 호출

고급 사용법

동적 값 자동 생성

변수 사용

TLS 활성화

서버 주소 및 환경 관리

Proto 파일 및 API 매개변수 보기

Proto 파일 내용 보기

요청 및 응답 매개변수 보기

디버깅 정보 저장