genopenrpc

Documentation

Overview

Package genopenrpc generates Open-RPC spec by proto files.

Index

• Variables
• func Run(gen *protogen.Plugin) error

Variables

var (
	// ErrNoServicesInFiles is returned when all proto-files do not contain service directives.
	ErrNoServicesInFiles = errors.New("proto files do not contain services")
	// ErrServiceNotFound is returned when service with required name not found in list service.
	ErrServiceNotFound = errors.New("service not found")
	// ErrMessageIsNil is returned when you try to generate empty message.
	ErrMessageIsNil = errors.New("message is nil")
	// ErrInvalidKeyType is returned when key of the map field is wrong.
	ErrInvalidKeyType = errors.New("key of the map should be string or number")
)

var (
	// Version of the generator.
	Version = "(unknown)"
	// MethodsWithServiceName specifies that name of methods will be generate with service name.
	MethodsWithServiceName = false
	// GenerateServices service names to generate, all if it empty.
	GenerateServices = []string{}
	// ServiceDescriptionsPath path to json file with service descriptions.
	ServiceDescriptionsPath = ""
)

Some variables as config of generator.

Functions

func Run

func Run(gen *protogen.Plugin) error

Run loops through files to generate and creates spec file.