rpcgen

README

rpcgen: JSON-RPC 2.0 Client Generator Implementation for zenrpc

rpcgen is a JSON-RPC 2.0 client library generator for zenrpc. It supports client generation for following languages:

• Golang
• TypeScript

Examples

Basic usage

package main

import (
	"fmt"
	"log"
	"net/http"

	"github.com/semrush/zenrpc/v2"
	"github.com/vmkteam/rpcgen"
)

func main() {
	rpc := zenrpc.NewServer(zenrpc.Options{})

	generated, err := rpcgen.FromSMD(rpc.SMD()).GoClient().Generate()
	if err != nil {
		log.Fatal(err)
	}
	
	fmt.Printf("%s", generated)
}

Generate in HTTP handler

package main 

import (
	"net/http"
	
	"github.com/semrush/zenrpc/v2"
	"github.com/vmkteam/rpcgen"
)

func main () {
	rpc := zenrpc.NewServer(zenrpc.Options{})

	gen := rpcgen.FromSMD(rpc.SMD())

	http.HandleFunc("/client.go", rpcgen.Handler(gen.GoClient()))
	http.HandleFunc("/client.ts", rpcgen.Handler(gen.TSClient(nil)))
}

Add custom TypeScript type mapper

package main

import (
	"net/http"

	"github.com/semrush/zenrpc/v2"
	"github.com/semrush/zenrpc/v2/smd"
	"github.com/vmkteam/rpcgen"
	"github.com/vmkteam/rpcgen/typescript"
)

func main() {
	rpc := zenrpc.NewServer(zenrpc.Options{})

	gen := rpcgen.FromSMD(rpc.SMD())

	typeMapper := func(in smd.JSONSchema, tsType typescript.Type) typescript.Type {
		if in.Type == "object" {
			if in.Description == "Group" && in.Name == "groups" {
				tsType.Type = fmt.Sprintf("Record<number, I%s>", in.Description)
			}
		}
		
		return tsType
	}

	http.HandleFunc("/client.ts", rpcgen.Handler(gen.TSClient(typeMapper)))
}

Documentation

Index

• func Handler(gen Generator) func(http.ResponseWriter, *http.Request)
• type Generator
• type RPCGen
  • func FromSMD(schema smd.Schema) *RPCGen
  • func FromSMDv1(schema smd1.Schema) *RPCGen
  • func (g RPCGen) GoClient() Generator
  • func (g RPCGen) TSClient(typeMapper typescript.TypeMapper) Generator

Functions

func Handler

func Handler(gen Generator) func(http.ResponseWriter, *http.Request)

Handler create http handler with fn

Types

type Generator

type Generator interface {
	Generate() ([]byte, error)
}

type RPCGen

type RPCGen struct {
	// contains filtered or unexported fields
}

func FromSMD

func FromSMD(schema smd.Schema) *RPCGen

FromSMD create Generator from smd schema

func FromSMDv1

func FromSMDv1(schema smd1.Schema) *RPCGen

FromSMDv1 create Generator from smd v1 schema

func (RPCGen) GoClient

func (g RPCGen) GoClient() Generator

func (RPCGen) TSClient

func (g RPCGen) TSClient(typeMapper typescript.TypeMapper) Generator