compiler

Documentation

Overview

Package compiler contains tools to take openapi.* definitions and compile them into protobuf.* structures.

Index

• func Compile(spec *openapi.Spec, options ...Option) (*protobuf.Package, error)
• type Option
  • func WithAnnotation(b bool) Option
  • func WithPrefixEnums(b bool) Option
  • func WithSkipRpcs(b bool) Option
  • func WithWrapPrimitives(b bool) Option
• type Parameter
  • func (p *Parameter) ParameterName() string
  • func (p *Parameter) ParameterNumber() int
  • func (p *Parameter) ParameterType() protobuf.Type
  • func (p *Parameter) Repeated() bool

Functions

func Compile

func Compile(spec *openapi.Spec, options ...Option) (*protobuf.Package, error)

Compile takes an OpenAPI spec and compiles it into a protobuf.Package.

Types

type Option

type Option = option.Option

Option is used to pass options to several methods

func WithAnnotation

func WithAnnotation(b bool) Option

WithAnnotation creates a new Option to specify if we should add google.api.http annotation to the compiled Protocol Buffers structure

func WithPrefixEnums

func WithPrefixEnums(b bool) Option

prefix enum values with their enum name to prevent protobuf namespacing issues

func WithSkipRpcs

func WithSkipRpcs(b bool) Option

WithSkipRpcs creates a new Option to specify if we should generate services and rpcs in addition to messages

func WithWrapPrimitives

func WithWrapPrimitives(b bool) Option

wrap primitive types with their wrapper message types see https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/wrappers.proto and https://developers.google.com/protocol-buffers/docs/proto3#default

type Parameter

type Parameter struct {
	protobuf.Type
	// contains filtered or unexported fields
}

Parameter is used to represent a parameter.

func (*Parameter) ParameterName

func (p *Parameter) ParameterName() string

ParameterName returns the parameter name

func (*Parameter) ParameterNumber

func (p *Parameter) ParameterNumber() int

ParameterNumber returns the number to be assigned

func (*Parameter) ParameterType

func (p *Parameter) ParameterType() protobuf.Type

ParameterType returns the underlying protobuf.Type

func (*Parameter) Repeated

func (p *Parameter) Repeated() bool

Repeated returns true if this parameter can be repeated