gRPC Debugging

gRPC Entry Point

SyncTV public gRPC and HTTP REST share server.port, default 8080.

server.enable_reflection=true by default, so development environments can explore services with grpcurl. Production should usually disable reflection and use checked-in protobuf files.

Caution

gRPC reflection exposes service and message structure. It is useful for development, internal debugging, and staging, but should not be left enabled on public production endpoints.

Use grpcurl

Reflection

Start with reflection:

SYNCTV_SERVER_ENABLE_REFLECTION=true \
cargo run -p synctv --bin synctv -- serve

List services:

grpcurl -plaintext localhost:8080 list
grpcurl -plaintext localhost:8080 list synctv.client.AuthService

Public client services include synctv.client.AuthService, UserService, RoomService, PublicService, EmailService, NotificationService, and OAuth2Service. The public admin gRPC service is synctv.admin.AdminService. The management gRPC service is a separate endpoint named synctv.management.ManagementService; it is not served on server.port.

Protobuf Files

Use repository protobuf files without reflection:

grpcurl -plaintext \
  -import-path synctv-proto \
  -proto proto/client.proto \
  localhost:8080 \
  synctv.client.AuthService/Login

-plaintext is for local development or trusted internal networks only. Production deployments should use TLS at the proxy or client connection layer.

Register Example

grpcurl -plaintext -d '{
  "username": "alice",
  "email": "alice@example.com",
  "password": "securepassword123"
}' localhost:8080 synctv.client.AuthService/Register

Login Example

grpcurl -plaintext -d '{
  "username": "alice",
  "password": "securepassword123"
}' localhost:8080 synctv.client.AuthService/Login

Relationship With OpenAPI

OpenAPI documents HTTP APIs only. gRPC debugging uses reflection or protobuf files. See OpenAPI Access for Swagger UI and OpenAPI JSON.

Next Pages

• Client Integration Guide
• OpenAPI Access