Protocol Buffers (gRPC)

Loading a gRPC API Definition

Vaktum supports testing and validation for gRPC APIs through Protocol Buffer (protobuf) definitions.

About gRPC

gRPC is a high-performance, open-source universal RPC framework developed by Google. It uses Protocol Buffers (protobuf) as its interface definition language, allowing you to define your service methods and message types in .proto files.

Uploading Protobuf Definitions

Via Vaktum.com

1. Navigate to the APIs section of Vaktum.com
2. Click "Upload API"
3. Select "gRPC/Protobuf" as the API type
4. Upload your .proto files
5. Vaktum will parse your proto definitions and make them available for testing

Via Vaktum API

You can programmatically upload your protobuf definitions using the Vaktum API:

curl -X POST "https://api.vaktum.com/v1/apis/grpc" \
  -H "X-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"name": "My gRPC API", "description": "gRPC API description", "files": ["base64-encoded-proto-file-1", "base64-encoded-proto-file-2"]}'

Supported Features

Vaktum's gRPC support includes:

• Service Discovery: Automatic detection of service definitions in your proto files
• Method Mapping: Identification of all available RPC methods
• Message Validation: Verification of request and response message structures
• Test Generation: Automatic creation of test cases for your gRPC services
• Support for Multiple Files: Handling imports and dependencies across multiple proto files

Using gRPC in Tests

Once your gRPC API is loaded into Vaktum, you can:

1. Create test scenarios for your service methods
2. Generate sample requests based on your message definitions
3. Execute tests against your gRPC endpoints
4. Validate responses against expected schemas

For more information on testing gRPC APIs, see the Testing Capabilities section.