gRPC API generator

Common library for the Spichki Game project. It's provide gRPC API (server + client stubs) for gateway-to-microservice communication.

Usage

Add grpc-api-generator library to Poetry config:

# File: pyproject.toml

[tool.poetry.dependencies]
grpc-api-generator = {git = "https://github.com/Spichki-Game/gRPC-API-generator.git"}

[tool.poetry.scripts]
generate-api = "grpc_api_generator:run"

Alternatively, you can use Poetry CLI:

poetry add git https://github.com/Spichki-Game/gRPC-API-generator.git

After the above steps, run your script to generate gRPC API:

poetry run generate-api $SERVICE_NAME

For example:

• Protobuf:

synax = "proto3";
package = service_name;


service ServiceName {
    rpc RpcName(RequestNameType) returns(ResponseNameType);
}

message RequestNameType {
    string field_name = 1;
}

message ResponseNameType {
    string field_name_a = 1;
    int32 field_name_b = 2;
}

• Microservice (as server):

import grpc
import asyncio

from grpc_api import service_name_pb2 as msg
from grpc_api import service_name_pb2_grpc as srv


LISTEN_ADDR = "172.30.100.101:50051"


class ServiceName(srv.ServiceNameServicer):
    async def RpcName(self,
                      request: msg.RequestNameType,
                      context: grpc.aoi.ServicerContext) -> msg.ResponseNameType:
        
        return msg.ResponseNameType(
            field_name_a="Peavey EVH",
            field_name_b=5150
        )
        
        
async def service_name_server() -> None:
    server = grpc.aio.server()
    
    srv.add_ServiceNameServicer_to_server(
        ServiceName(),
        server
    )
    
    server.add_insecure_port(LISTEN_ADDR)
    
    await server.start()
    await server.wait_for_termination()
    
    
def start() -> None:
    print("[ Start ]: Service_name server\n")
    
    asyncio.run(
        service_name_server()
    )

• API Gateway (as client):

import grpc

from grpc_api import service_name_pb2 as msg
from grpc_api import service_name_pb2_grpc as srv


SERVICE_ADDR = "172.30.100.102:50051"


async def service_name_client() -> None:
    async with grpc.aio.insecure_channel(SERVICE)
        stub = srv.ServiceNameStub(channel)
        
        response: msg.ResponseNameType = await stub.RpcName(
            msg.RequestNameType(
                field_name="Guitar stack"
            )
        )
        
        print(response)

Required microservice project structure

service_name/:
   docs/:
      - etc...
      
   src/:

      name_of_other_package/:
         - __init__.py
         - etc...

      service_name/:
         - __init__.py
         - etc...

      grpc_api/:
         - __init__.py
         - name_of_main_package_pb2.py       # generated types from proto schema
         - name_of_main_package_pb2_grpc.py  # generated server and client stubs

      protobuf/:
         - service_name.proto
         
   tests/:
      - etc...

   - .dockerignore
   - Dockerfile
   - LICENSE
   - README.md
   - pyproject.toml