openapi

package

Go to main page

Versions in this module

v0

v0.0.17

May 20, 2024

v0.0.16

Nov 13, 2023

Changes in this version

type OpenAPI

+ func LoadFromYaml(openApiFilepath string) (*OpenAPI, error)

v0.0.15

Jun 12, 2023

v0.0.14

May 23, 2023

v0.0.13

Apr 9, 2023

v0.0.12

Apr 5, 2023

v0.0.11

Mar 18, 2023

v0.0.10

Mar 17, 2023

v0.0.9

Mar 16, 2023

v0.0.8

Mar 15, 2023

v0.0.7

Mar 4, 2023

Changes in this version

type OpenAPI

+ func LoadAPISpec(openAPIFile string) (*OpenAPI, error)

+ func (o *OpenAPI) GetChildren() map[string]tree.NodeTraverser

+ func (o *OpenAPI) GetRef() string

+ func (o *OpenAPI) SetChild(i string, child tree.NodeTraverser)

v0.0.6

Jan 20, 2023

v0.0.5

Jan 20, 2023

v0.0.4

Jan 17, 2023

Changes in this version

+ func SetRenderer(api *OpenAPI, renderer Renderer) error

+ func Traverse(node T, f TraversalFunc) (T, error)

+ func TraverseRecursor(node T, f TraversalFunc) (T, error)

+ type Callback struct

type Components

+ Callbacks map[string]Callback

+ Examples map[string]Example

+ Headers map[string]Header

+ Links map[string]Link

+ Parameters map[string]Parameter

+ SecuritySchemes map[string]SecurityScheme

+ type Config struct

+ OpenAPIFile string

+ type Example struct

+ Description string

+ ExternalValue string

+ Summary string

+ Value interface{}

type ExternalDocs

+ Description string

+ Url string

+ type GinRenderer struct

+ type Header struct

type Info

+ Contact struct{ ... }

+ TermsOfService string

+ type Link struct

type MediaType

+ func (m *MediaType) GetName() string

+ func (n *MediaType) GetMetadata() map[string]string

+ func (n *MediaType) GetOutputFile() string

+ func (n *MediaType) GetParent() Traversable

+ func (n *MediaType) SetMetadata(metadata map[string]string)

type OpenAPI

+ func (n *OpenAPI) GetParent() Traversable

+ func (o *OpenAPI) GetMetadata() map[string]string

+ func (o *OpenAPI) GetName() string

+ func (o *OpenAPI) GetOutputFile() string

+ func (o *OpenAPI) SetMetadata(metadata map[string]string)

type Operation

+ func (n *Operation) GetMetadata() map[string]string

+ func (n *Operation) GetName() string

+ func (n *Operation) GetOutputFile() string

+ func (n *Operation) GetParent() Traversable

+ func (n *Operation) SetMetadata(metadata map[string]string)

type Parameter

+ Deprecated bool

+ Ref string

+ func (n *Parameter) GetMetadata() map[string]string

+ func (n *Parameter) GetName() string

+ func (n *Parameter) GetOutputFile() string

+ func (n *Parameter) GetParent() Traversable

+ func (n *Parameter) SetMetadata(metadata map[string]string)

type PathItem

+ func (n *PathItem) GetMetadata() map[string]string

+ func (n *PathItem) GetName() string

+ func (n *PathItem) GetOutputFile() string

+ func (n *PathItem) GetParent() Traversable

+ func (n *PathItem) SetMetadata(metadata map[string]string)

+ func (p *PathItem) GetPath() string

+ type Renderer interface

type RequestBody

+ Ref string

+ func (n *RequestBody) GetMetadata() map[string]string

+ func (n *RequestBody) GetOutputFile() string

+ func (n *RequestBody) GetParent() Traversable

+ func (n *RequestBody) SetMetadata(metadata map[string]string)

+ func (r *RequestBody) GetName() string

type Response

+ Headers map[string]Header

+ Links map[string]Link

+ Ref string

+ func (n *Response) GetMetadata() map[string]string

+ func (n *Response) GetOutputFile() string

+ func (n *Response) GetParent() Traversable

+ func (n *Response) SetMetadata(metadata map[string]string)

+ func (r *Response) GetName() string

type Schema

+ func (n *Schema) GetMetadata() map[string]string

+ func (n *Schema) GetName() string

+ func (n *Schema) GetOutputFile() string

+ func (n *Schema) GetParent() Traversable

+ func (n *Schema) SetMetadata(metadata map[string]string)

+ func (s *Schema) GetType() string

+ type SecurityScheme struct

+ type Server struct

+ Description string

+ Url string

+ Variables map[string]ServerVariable

+ type ServerVariable struct

+ Default string

+ Description string

+ Enum []string

+ type Traversable interface

+ GetMetadata func() map[string]string

+ GetName func() string

+ GetOutputFile func() string

+ GetParent func() Traversable

+ SetMetadata func(metadata map[string]string)

+ func Dig(node Traversable, key ...string) Traversable

+ type TraversalFunc func(key string, parent, child Traversable) (Traversable, error)

v0.0.3

Sep 30, 2022

v0.0.2

Sep 30, 2022

Changes in this version

type Schema

+ Format string

+ Pattern string

+ Required []string

v0.0.1

Sep 29, 2022

Changes in this version

+ type Components struct

+ RequestBodies map[string]RequestBody

+ Responses map[string]Response

+ Schemas map[string]Schema

+ type ExternalDocs struct

+ type Info struct

+ Description string

+ License struct{ ... }

+ Title string

+ Version string

+ type MediaType struct

+ Schema Schema

+ func (m *MediaType) ResolveRefs(basePath string, components *Components) error

+ type OpenAPI struct

+ Components Components

+ Info Info

+ OpenAPI string

+ Paths Paths

+ Servers Servers

+ func LoadOpenAPI(openAPIFile string) (*OpenAPI, error)

+ func (o *OpenAPI) ResolveRefs(basePath string, components *Components) error

+ type Operation struct

+ Description string

+ ExternalDocs ExternalDocs

+ OperationId string

+ Parameters []Parameter

+ RequestBody RequestBody

+ Responses map[string]Response

+ Summary string

+ Tags []string

+ func (o *Operation) ResolveRefs(basePath string, components *Components) error

+ type Parameter struct

+ AllowEmptyValue bool

+ Description string

+ In string

+ Name string

+ Required bool

+ Schema Schema

+ func (p *Parameter) ResolveRefs(basePath string, components *Components) error

+ type PathItem struct

+ Delete *Operation

+ Description string

+ Get *Operation

+ Parameters []Parameter

+ Patch *Operation

+ Post *Operation

+ Ref string

+ Summary string

+ func (p *PathItem) Operations() map[string]*Operation

+ func (p *PathItem) ResolveRefs(basePath string, components *Components) error

+ type Paths map[string]PathItem

+ func (p *Paths) ResolveRefs(basePath string, components *Components) error

+ type RequestBody struct

+ Content map[string]MediaType

+ Description string

+ Required bool

+ func (r *RequestBody) ResolveRefs(basePath string, components *Components) error

+ type Response struct

+ Content map[string]MediaType

+ Description string

+ func (r *Response) ResolveRefs(basePath string, components *Components) error

+ type Schema struct

+ AdditionalProperties bool

+ Description string

+ Items *Schema

+ MaxLength int

+ MinLength int

+ Name string

+ Properties map[string]Schema

+ Ref string

+ Type string

+ func (s *Schema) ResolveRefs(basePath string, components *Components) error

+ type Servers []struct

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL