generator

Documentation

Index

• type Generator
  • func NewGenerator(options ...Option) *Generator
  • func (g *Generator) Gen(req *pluginpb.CodeGeneratorRequest, onlyRPC bool) (*pluginpb.CodeGeneratorResponse, error)
• type Option
  • func DisableDefaultErrors(b bool) Option
  • func EnumsAsInts(b bool) Option
  • func MergeFileName(name string) Option
  • func RecursiveDepth(depth int) Option
  • func UseJSONNamesForFields(b bool) Option

Types

type Generator

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

Generator is openapi v2 generator

func NewGenerator

func NewGenerator(options ...Option) *Generator

NewGenerator return Generator

func (*Generator) Gen

func (g *Generator) Gen(req *pluginpb.CodeGeneratorRequest, onlyRPC bool) (*pluginpb.CodeGeneratorResponse, error)

Gen generates openapi v2 json content

type Option

type Option func(gen *Generator)

func DisableDefaultErrors

func DisableDefaultErrors(b bool) Option

DisableDefaultErrors. if set, disables generation of default errors. This is useful if you have defined custom error handling

func EnumsAsInts

func EnumsAsInts(b bool) Option

EnumsAsInts. whether to render enum values as integers, as opposed to string values

func MergeFileName

func MergeFileName(name string) Option

MergeFileName. target OpenAPI file name prefix after merge

func RecursiveDepth

func RecursiveDepth(depth int) Option

RecursiveDepth. maximum recursion count allowed for a field type

func UseJSONNamesForFields

func UseJSONNamesForFields(b bool) Option

UseJSONNamesForFields. if disabled, the original proto name will be used for generating OpenAPI definitions