genswagger

Documentation

Overview

Package genswagger contains method for generate swagger config from protobuf file.

Index

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

Variables

var (
	// Version of the generator.
	Version = "v0.0.0-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 = ""
	// ServicesVersion sets the version of the services if it is not empty.
	ServicesVersion = ""
	// AllTypes genereates all type from proto files.
	AllTypes = false
	// HideVersions do not prints version of the protoc and protoc-gen-swagger-pjrpc.
	HideVersions = false
)

Some variables as config of generator.

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")
	// ErrInvalidKeyType is returned when key of the map field is wrong.
	ErrInvalidKeyType = errors.New("key of the map should be string or integer")
)

Functions

func Run

func Run(gen *protogen.Plugin) error

Run loops through files to generate and creates spec file.