gRPC APIs

Applies to ReadyAPI 3.40.1, last modified on June 29, 2022

ReadyAPI shows gRPC APIs in a tree structure for better readability. gRPC APIs are organized in the following way:

The gRPC API Structure

Click the image to enlarge it.

Packages

A .proto file may declare a package. ReadyAPI represents a package as a folder in the APIs node. The package node contains all the gRPC services from that package even if you added them from separate .proto files.

gRPC service

A gRPC service is a top-level node of the gRPC services in the Navigator panel. Select it to see and modify endpoints.

Endpoints

The Endpoints page is the central place where you manage endpoints used in the gRPC API.

Testing gRPC APIs in ReadyAPI: The Endpoints page

Click the image to enlarge it.

You can configure the following options:

Option Description

Endpoint

The endpoint URL or destination.

Environment

An environment associated with the endpoint.

You can create only one endpoint associated with each environment. When you add a new endpoint associated with the same environment, the new endpoint will overwrite the existing one.

Authorization Profile

An authorization profile used to access the endpoint.

A gRPC service supports only the OAuth 2.0 authorization type.
Work with environments

When you do not use an environment, you can enter any endpoint in an API Connection test step or select one of the values specified in the gRPC API node:

Testing gRPC APIs in ReadyAPI: Set endpoins without environments

Click the image to enlarge it.

When you set an environment, the test step will use the endpoint associated with this environment:

Testing gRPC APIs in ReadyAPI: Set endpoins with environments

Click the image to enlarge it.

Organize gRPC service

Deleting service

To delete a gRPC service, select it in the Navigator panel and press Shift+Delete, then confirm that you no longer need it.

Adding operations to functional tests

To add an operation to a functional test:

  1. Right-click the operation in the Navigator panel and select Add to Test Case.

  2. Select the test case to add the created API Connection test step to. You can also create a new test case or test suite and place the request there. Click Add Test Step.

See Also

Kafka Testing
Working With APIs

Highlight search results