openapi3Struct

README

openapi3Struct

Openapi3 struct parser

Documentation

Index

• type Option
  • func WithPackagePaths(paths []string) Option
• type Parser
  • func NewParser(t openapi3.T, options ...Option) *Parser
  • func (p *Parser) AddPath(epDoc domain.EndpointDoc)
  • func (p *Parser) ParseSchemasFromStructs() error
  • func (p *Parser) SaveJsonToFile(path string) error
  • func (p *Parser) SaveYamlToFile(path string) error
  • func (p *Parser) Validate(ctx context.Context) error

Types

type Option

type Option func(p Parser) Parser

func WithPackagePaths

func WithPackagePaths(paths []string) Option

type Parser

type Parser struct {
	T openapi3.T
	// contains filtered or unexported fields
}

func NewParser

func NewParser(t openapi3.T, options ...Option) *Parser

func (*Parser) AddPath

func (p *Parser) AddPath(epDoc domain.EndpointDoc)

func (*Parser) ParseSchemasFromStructs

func (p *Parser) ParseSchemasFromStructs() error

func (*Parser) SaveJsonToFile

func (p *Parser) SaveJsonToFile(path string) error

func (*Parser) SaveYamlToFile

func (p *Parser) SaveYamlToFile(path string) error

func (*Parser) Validate

func (p *Parser) Validate(ctx context.Context) error

Validate resolves refs and validates schema