genswagger

package

Go to main page

Versions in this module

v1

v1.2.0

Apr 17, 2017

Changes in this version

type Generator

+ func NewGenerator(options ...Option) *Generator

+ type Option func(*Generator)

+ func API(API *design.APIDefinition) Option

+ func OutDir(outDir string) Option

v1.1.0

Dec 14, 2016

Changes in this version

type Generator

+ API *design.APIDefinition

+ OutDir string

type Info

+ Extensions map[string]interface{}

+ func (i Info) MarshalJSON() ([]byte, error)

type Operation

+ Extensions map[string]interface{}

+ func (o Operation) MarshalJSON() ([]byte, error)

type Parameter

+ Extensions map[string]interface{}

+ func (p Parameter) MarshalJSON() ([]byte, error)

type Path

+ Extensions map[string]interface{}

+ func (p Path) MarshalJSON() ([]byte, error)

type Response

+ Extensions map[string]interface{}

+ func (r Response) MarshalJSON() ([]byte, error)

type SecurityDefinition

+ Extensions map[string]interface{}

+ func (s SecurityDefinition) MarshalJSON() ([]byte, error)

type Tag

+ Extensions map[string]interface{}

+ func (t Tag) MarshalJSON() ([]byte, error)

v1.0.0

Aug 2, 2016

Changes in this version

+ func Generate() (files []string, err error)

+ type ExternalDocs struct

+ Description string

+ URL string

+ type Generator struct

+ func (g *Generator) Cleanup()

+ func (g *Generator) Generate(api *design.APIDefinition) (_ []string, err error)

+ type Header struct

+ CollectionFormat string

+ Default interface{}

+ Description string

+ Enum []interface{}

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Format string

+ Items *Items

+ MaxItems *int

+ MaxLength *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ Minimum *float64

+ MultipleOf float64

+ Pattern string

+ Type string

+ UniqueItems bool

+ type Info struct

+ Contact *design.ContactDefinition

+ Description string

+ License *design.LicenseDefinition

+ TermsOfService string

+ Title string

+ Version string

+ type Items struct

+ CollectionFormat string

+ Default interface{}

+ Enum []interface{}

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Format string

+ Items *Items

+ MaxItems *int

+ MaxLength *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ Minimum *float64

+ MultipleOf float64

+ Pattern string

+ Type string

+ UniqueItems bool

+ type Operation struct

+ Consumes []string

+ Deprecated bool

+ Description string

+ ExternalDocs *ExternalDocs

+ OperationID string

+ Parameters []*Parameter

+ Produces []string

+ Responses map[string]*Response

+ Schemes []string

+ Security []map[string][]string

+ Summary string

+ Tags []string

+ type Parameter struct

+ AllowEmptyValue bool

+ CollectionFormat string

+ Default interface{}

+ Description string

+ Enum []interface{}

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Format string

+ In string

+ Items *Items

+ MaxItems *int

+ MaxLength *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ Minimum *float64

+ MultipleOf float64

+ Name string

+ Pattern string

+ Required bool

+ Schema *genschema.JSONSchema

+ Type string

+ UniqueItems bool

+ type Path struct

+ Delete *Operation

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters []*Parameter

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Ref string

+ type Response struct

+ Description string

+ Headers map[string]*Header

+ Ref string

+ Schema *genschema.JSONSchema

+ type Scope struct

+ Description string

+ type SecurityDefinition struct

+ AuthorizationURL string

+ Description string

+ Flow string

+ In string

+ Name string

+ Scopes map[string]string

+ TokenURL string

+ Type string

+ type Swagger struct

+ BasePath string

+ Consumes []string

+ Definitions map[string]*genschema.JSONSchema

+ ExternalDocs *ExternalDocs

+ Host string

+ Info *Info

+ Parameters map[string]*Parameter

+ Paths map[string]*Path

+ Produces []string

+ Responses map[string]*Response

+ Schemes []string

+ SecurityDefinitions map[string]*SecurityDefinition

+ Swagger string

+ Tags []*Tag

+ func New(api *design.APIDefinition) (*Swagger, error)

+ type Tag struct

+ Description string

+ ExternalDocs *ExternalDocs

+ Name string

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