doc

Documentation

Index

• type Generator
  • func NewOpenapiGenerator(filter *regexp.Regexp, structTag string) Generator
• type SpecRegistry
  • func (s SpecRegistry) AddSchema(key string, schema spec.Schema)
  • func (s SpecRegistry) AddSchemaProp(props spec.SchemaProps)
  • func (s SpecRegistry) Extend(r SpecRegistry)
  • func (s SpecRegistry) Values() (specs []spec.Schema)

Types

type Generator

type Generator interface {
	DocumentStruct(_package ...string) ([]spec.Schema, error)
}

Generator generated the OpenAPI document for the named packages

func NewOpenapiGenerator

func NewOpenapiGenerator(filter *regexp.Regexp, structTag string) Generator

NewOpenapiGenerator returns a new Generator

type SpecRegistry

type SpecRegistry map[string]spec.Schema

SpecRegistry holds spec.Schema registered by a given key

func (SpecRegistry) AddSchema

func (s SpecRegistry) AddSchema(key string, schema spec.Schema)

AddSchema register a spec.Schema registered by a given key

func (SpecRegistry) AddSchemaProp

func (s SpecRegistry) AddSchemaProp(props spec.SchemaProps)

AddSchemaProp is a convenience methods to call AddSchema for a spec.SchemaProps for which a spec.Schema is created and key is derived from SchemaProps ID

func (SpecRegistry) Extend

func (s SpecRegistry) Extend(r SpecRegistry)

func (SpecRegistry) Values

func (s SpecRegistry) Values() (specs []spec.Schema)