generator

Documentation

Index

• Variables
• type Generator
  • func NewGenerator(plugin *protogen.Plugin, inputFile *protogen.File, ...) *Generator
  • func (g *Generator) OutputFile() *protogen.GeneratedFile
  • func (g *Generator) PrintBodyParameters(body string, bodyDoc *openapi_v3.RequestBodyOrReference)
  • func (g *Generator) Run() error

Variables

var GrpcClient *bool

var GrpcServer *bool

Types

type Generator

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

Generator holds internal state needed to generate an OpenAPIv3 document for a transcoded Protocol Buffer service.

func NewGenerator

func NewGenerator(
	plugin *protogen.Plugin,
	inputFile *protogen.File,
	outputFile *protogen.GeneratedFile,
	openAPIv3Generator *generator.OpenAPIv3Generator,
) *Generator

NewGenerator creates a new generator for a protoc plugin invocation.

func (*Generator) OutputFile

func (g *Generator) OutputFile() *protogen.GeneratedFile

func (*Generator) PrintBodyParameters

func (g *Generator) PrintBodyParameters(body string, bodyDoc *openapi_v3.RequestBodyOrReference)

func (*Generator) Run

func (g *Generator) Run() error

Run runs the generator.