swagger

Documentation

Index

• Variables
• func WithApiKeyAuthentication(customApiHeader string) func(target *spec.Swagger)
• func WithBearerAuthentication() func(target *spec.Swagger)
• func WithVersion(version string) func(target *spec.Swagger)
• type SwaggerOpt
• type Writer
  • func NewWriter(filename, hostname, pathPrefix string, swaggerOpt ...SwaggerOpt) *Writer
  • func (sw *Writer) Enum(enum *proto.Enum)
  • func (sw *Writer) Get() []byte
  • func (sw *Writer) Handlers() []proto.Handler
  • func (sw *Writer) Import(i *proto.Import)
  • func (sw *Writer) Message(msg *proto.Message)
  • func (sw *Writer) Package(pkg *proto.Package)
  • func (sw *Writer) RPC(rpc *proto.RPC)
  • func (sw *Writer) Save(filename string) error
  • func (sw *Writer) Service(service *proto.Service)
  • func (sw *Writer) WalkFile() error

Variables

var ErrNoServiceDefinition = errors.New("no service definition found")

Functions

func WithApiKeyAuthentication

func WithApiKeyAuthentication(customApiHeader string) func(target *spec.Swagger)

func WithBearerAuthentication

func WithBearerAuthentication() func(target *spec.Swagger)

func WithVersion

func WithVersion(version string) func(target *spec.Swagger)

Types

type SwaggerOpt

type SwaggerOpt func(*spec.Swagger)

type Writer

type Writer struct {
	*spec.Swagger
	// contains filtered or unexported fields
}

func NewWriter

func NewWriter(filename, hostname, pathPrefix string, swaggerOpt ...SwaggerOpt) *Writer

func (*Writer) Enum

func (sw *Writer) Enum(enum *proto.Enum)

func (*Writer) Get

func (sw *Writer) Get() []byte

func (*Writer) Handlers

func (sw *Writer) Handlers() []proto.Handler

func (*Writer) Import

func (sw *Writer) Import(i *proto.Import)

func (*Writer) Message

func (sw *Writer) Message(msg *proto.Message)

func (*Writer) Package

func (sw *Writer) Package(pkg *proto.Package)

func (*Writer) RPC

func (sw *Writer) RPC(rpc *proto.RPC)

func (*Writer) Save

func (sw *Writer) Save(filename string) error

func (*Writer) Service

func (sw *Writer) Service(service *proto.Service)

func (*Writer) WalkFile

func (sw *Writer) WalkFile() error