openapi

package

Go to main page

Versions in this module

v0

v0.14.1

Apr 29, 2024

v0.14.0

Apr 29, 2024

v0.13.15

Apr 4, 2020

v0.13.14

Mar 12, 2020

v0.13.13

Mar 12, 2020

v0.13.12

Mar 12, 2020

v0.13.11

Mar 12, 2020

v0.13.10

Mar 12, 2020

Changes in this version

type APIOperation

+ GetSecurity func() map[string]interface{}

type Operation

+ func (operation *Operation) GetSecurity() map[string]interface{}

v0.13.9

Mar 12, 2020

Changes in this version

type Operation

+ Security map[string]interface{}

type OperationInfo

+ Security map[string]interface{}

v0.13.8

Mar 12, 2020

v0.13.7

Mar 12, 2020

Changes in this version

+ type ApiKeyAuth struct

+ In string

+ Name string

+ Type string

type Components

+ SecurityScheme map[string]interface{}

type Generator

+ func (g *Generator) SetAPIKeySecurity(info *Info)

v0.13.6

Feb 28, 2020

Changes in this version

+ type APIOperation interface

+ GetDeprecated func() bool

+ GetDescription func() string

+ GetID func() string

+ GetParameters func() []*ParameterOrRef

+ GetRequestBody func() *RequestBody

+ GetResponses func() Responses

+ GetServers func() []*Server

+ GetSummary func() string

+ GetTags func() []string

+ Marshal func() ([]byte, error)

+ Unmarshal func(data []byte, v interface{}) error

+ type Components struct

+ Examples map[string]*ExampleOrRef

+ Headers map[string]*HeaderOrRef

+ Parameters map[string]*ParameterOrRef

+ Responses map[string]*ResponseOrRef

+ Schemas map[string]*SchemaOrRef

+ type Contact struct

+ Email string

+ Name string

+ URL string

+ type DataType interface

+ Format func() string

+ Type func() string

+ func DataTypeFromType(t reflect.Type) DataType

+ type Encoding struct

+ AllowReserved bool

+ ContentType string

+ Explode bool

+ Headers map[string]*HeaderOrRef

+ Style string

+ type Example struct

+ Description string

+ ExternalValue string

+ Summary string

+ Value interface{}

+ type ExampleOrRef struct

+ func (eor *ExampleOrRef) MarshalYAML() (interface{}, error)

+ type FieldError struct

+ Message string

+ Name string

+ ParameterLocation string

+ Parent reflect.Type

+ Type reflect.Type

+ TypeName string

+ func (fe *FieldError) Error() string

+ type Generator struct

+ func NewGenerator(conf *SpecGenConfig) (*Generator, error)

+ func (g *Generator) API() *OpenAPI

+ func (g *Generator) AddOperation(path, method, tag string, in, out reflect.Type, info *OperationInfo) (*Operation, error)

+ func (g *Generator) AddTag(name, desc string)

+ func (g *Generator) Errors() []error

+ func (g *Generator) OverrideDataType(t reflect.Type, typ, format string) error

+ func (g *Generator) OverrideTypeName(t reflect.Type, name string) error

+ func (g *Generator) SetInfo(info *Info)

+ func (g *Generator) SetServers(servers []*Server)

+ func (g *Generator) SetSortParams(b bool)

+ func (g *Generator) SetSortTags(b bool)

+ func (g *Generator) UseFullSchemaNames(b bool)

+ type Header struct

+ AllowEmptyValue bool

+ Deprecated bool

+ Description string

+ Required bool

+ Schema *SchemaOrRef

+ type HeaderOrRef struct

+ func (hor *HeaderOrRef) MarshalYAML() (interface{}, error)

+ type Info struct

+ Contact *Contact

+ Description string

+ License *License

+ TermsOfService string

+ Title string

+ Version string

+ type InternalDataType int

+ const TypeBinary

+ const TypeBoolean

+ const TypeByte

+ const TypeComplex

+ const TypeDate

+ const TypeDateTime

+ const TypeDouble

+ const TypeDuration

+ const TypeFloat

+ const TypeIP

+ const TypeInteger

+ const TypeLong

+ const TypePassword

+ const TypeString

+ const TypeURL

+ const TypeUUID

+ const TypeUnsupported

+ func (dt InternalDataType) Format() string

+ func (dt InternalDataType) String() string

+ func (dt InternalDataType) Type() string

+ type License struct

+ Name string

+ URL string

+ type MediaType struct

+ Encoding map[string]*Encoding

+ Example interface{}

+ Examples map[string]*ExampleOrRef

+ Schema *SchemaOrRef

+ type MediaTypeOrRef struct

+ func (mtor *MediaTypeOrRef) MarshalYAML() (interface{}, error)

+ type OpenAPI struct

+ Components *Components

+ Info *Info

+ OpenAPI string

+ Paths Paths

+ Servers []*Server

+ Tags []*Tag

+ type Operation struct

+ Deprecated bool

+ Description string

+ ID string

+ Parameters []*ParameterOrRef

+ RequestBody *RequestBody

+ Responses Responses

+ Servers []*Server

+ Summary string

+ Tags []string

+ func (operation *Operation) GetDeprecated() bool

+ func (operation *Operation) GetDescription() string

+ func (operation *Operation) GetID() string

+ func (operation *Operation) GetParameters() []*ParameterOrRef

+ func (operation *Operation) GetRequestBody() *RequestBody

+ func (operation *Operation) GetResponses() Responses

+ func (operation *Operation) GetServers() []*Server

+ func (operation *Operation) GetSummary() string

+ func (operation *Operation) GetTags() []string

+ func (operation *Operation) Marshal() ([]byte, error)

+ func (operation *Operation) Unmarshal(data []byte, v interface{}) error

+ type OperationInfo struct

+ Deprecated bool

+ Description string

+ Headers []*ResponseHeader

+ ID string

+ InputModel interface{}

+ Responses []*OperationReponse

+ StatusCode int

+ StatusDescription string

+ Summary string

+ type OperationReponse struct

+ Code string

+ Description string

+ Headers []*ResponseHeader

+ Model interface{}

+ type OverridedDataType struct

+ func (dt *OverridedDataType) Format() string

+ func (dt *OverridedDataType) Type() string

+ type Parameter struct

+ AllowEmptyValue bool

+ Deprecated bool

+ Description string

+ Explode bool

+ In string

+ Name string

+ Required bool

+ Schema *SchemaOrRef

+ Style string

+ type ParameterOrRef struct

+ func (por *ParameterOrRef) MarshalYAML() (interface{}, error)

+ type PathItem struct

+ DELETE APIOperation

+ Description string

+ GET APIOperation

+ HEAD APIOperation

+ OPTIONS APIOperation

+ PATCH APIOperation

+ POST APIOperation

+ PUT APIOperation

+ Parameters []*ParameterOrRef

+ Ref string

+ Servers []*Server

+ Summary string

+ TRACE APIOperation

+ type Paths map[string]*PathItem

+ type Reference struct

+ Ref string

+ type RequestBody struct

+ Content map[string]*MediaType

+ Description string

+ Required bool

+ type Response struct

+ Content map[string]*MediaTypeOrRef

+ Description string

+ Headers map[string]*HeaderOrRef

+ type ResponseHeader struct

+ Description string

+ Model interface{}

+ Name string

+ type ResponseOrRef struct

+ func (ror *ResponseOrRef) MarshalYAML() (interface{}, error)

+ type Responses map[string]*ResponseOrRef

+ type Schema struct

+ AdditionalProperties *SchemaOrRef

+ AllOf *SchemaOrRef

+ AnyOf *SchemaOrRef

+ Default interface{}

+ Deprecated bool

+ Description string

+ Enum []interface{}

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Format string

+ Items *SchemaOrRef

+ MaxItems int

+ MaxLength int

+ MaxProperties int

+ Maximum int

+ MinItems int

+ MinLength int

+ MinProperties int

+ Minimum int

+ MultipleOf int

+ Nullable bool

+ OneOf *SchemaOrRef

+ Pattern string

+ Properties map[string]*SchemaOrRef

+ Required []string

+ Title string

+ Type string

+ UniqueItems bool

+ type SchemaOrRef struct

+ func (sor *SchemaOrRef) MarshalYAML() (interface{}, error)

+ type Server struct

+ Description string

+ URL string

+ Variables map[string]*ServerVariable

+ type ServerVariable struct

+ Default string

+ Description string

+ Ennum []string

+ type SpecGenConfig struct

+ DefaultTag string

+ EnumTag string

+ HeaderLocationTag string

+ PathLocationTag string

+ QueryLocationTag string

+ ValidatorTag string

+ type Tag struct

+ Description string

+ Name string

+ type TypeError struct

+ Message string

+ Type reflect.Type

+ func (te *TypeError) Error() string

+ type Typer interface

+ TypeName func() string

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