swgen

package module

Go to main page

Versions in this module

v0

v0.3.2

Jul 19, 2017

v0.3.1

Jul 14, 2017

v0.3.0

Jul 13, 2017

Changes in this version

+ const APIKeyInHeader

+ const APIKeyInQuery

+ const Oauth2AccessCode

+ const Oauth2Application

+ const Oauth2Implicit

+ const Oauth2Password

+ const SecurityAPIKey

+ const SecurityBasicAuth

+ const SecurityOAuth2

+ func ReflectTypeHash(t reflect.Type) uint32

+ func ReflectTypeReliableName(t reflect.Type) string

type Document

+ SecurityDefinitions map[string]SecurityDef

type Generator

+ func (g *Generator) AddSecurityDefinition(name string, def SecurityDef) *Generator

type OperationObj

+ Security map[string][]string

type PathItemInfo

+ Security []string

+ SecurityOAuth2 map[string][]string

type SchemaObj

+ func NewSchemaObj(jsonType, typeName string) (so *SchemaObj)

+ func (so SchemaObj) Export() SchemaObj

+ type SecurityDef struct

+ AuthorizationURL string

+ Flow oauthFlow

+ In apiKeyIn

+ Name string

+ Scopes map[string]string

+ TokenURL string

+ Type securityType

v0.2.1

May 30, 2017

v0.2.0

May 23, 2017

Changes in this version

+ const CommonNameBinary

+ const CommonNameBoolean

+ const CommonNameByte

+ const CommonNameDate

+ const CommonNameDateTime

+ const CommonNameDouble

+ const CommonNameFloat

+ const CommonNameInteger

+ const CommonNameLong

+ const CommonNamePassword

+ const CommonNameString

+ type Definition struct

+ TypeName string

+ func (s Definition) SwgenDefinition() (typeName string, typeDef SchemaObj, err error)

type Generator

+ func AddExtendedField(name string, value interface{}) *Generator

+ func EnableCORS(b bool, allowHeaders ...string) *Generator

+ func (g *Generator) AddExtendedField(name string, value interface{}) *Generator

+ func (g *Generator) EnableCORS(b bool, allowHeaders ...string) *Generator

+ func (g *Generator) IndentJSON(enabled bool) *Generator

+ func (g *Generator) ReflectGoTypes(enabled bool) *Generator

type ParamObj

+ func (ad *ParamObj) AddExtendedField(name string, value interface{})

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

type SchemaObj

+ GoPropertyNames map[string]string

+ GoPropertyTypes map[string]string

+ GoType string

+ func SchemaFromCommonName(name commonName) SchemaObj

v0.1.1

May 10, 2017

v0.1.0

Apr 20, 2017

Changes in this version

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

+ func ResetDefinitions()

+ func ResetPaths()

+ func ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func SetPathItem(info PathItemInfo, params interface{}, body interface{}, response interface{}) error

+ type ContactObj struct

+ Email string

+ Name string

+ URL string

+ type Document struct

+ BasePath string

+ Definitions map[string]SchemaObj

+ Host string

+ Info InfoObj

+ Paths map[string]PathItem

+ Schemes []string

+ Version string

+ func (ad *Document) AddExtendedField(name string, value interface{})

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

+ type Enum struct

+ Enum []interface{}

+ EnumNames []string

+ type Generator struct

+ func AddTypeMap(src interface{}, dst interface{}) *Generator

+ func NewGenerator() *Generator

+ func SetAttachVersionToHead(attachToHead bool) *Generator

+ func SetBasePath(basePath string) *Generator

+ func SetContact(name, url, email string) *Generator

+ func SetHost(host string) *Generator

+ func SetInfo(title, description, term, version string) *Generator

+ func SetLicense(name, url string) *Generator

+ func SetType(serviceType ServiceType) *Generator

+ func SetUppercaseVersion(uppercase bool) *Generator

+ func (g *Generator) AddTypeMap(src interface{}, dst interface{}) *Generator

+ func (g *Generator) GenDocument() ([]byte, error)

+ func (g *Generator) ParseDefinition(i interface{}) (schema SchemaObj, err error)

+ func (g *Generator) ParseParameter(i interface{}) (name string, params []ParamObj, err error)

+ func (g *Generator) ResetDefinitions()

+ func (g *Generator) ResetPaths()

+ func (g *Generator) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (g *Generator) SetAttachVersionToHead(attachToHead bool) *Generator

+ func (g *Generator) SetBasePath(basePath string) *Generator

+ func (g *Generator) SetContact(name, url, email string) *Generator

+ func (g *Generator) SetHost(host string) *Generator

+ func (g *Generator) SetInfo(title, description, term, version string) *Generator

+ func (g *Generator) SetLicense(name, url string) *Generator

+ func (g *Generator) SetPathItem(info PathItemInfo, params interface{}, body interface{}, response interface{}) error

+ func (g *Generator) SetType(serviceType ServiceType) *Generator

+ func (g *Generator) SetUppercaseVersion(uppercase bool) *Generator

+ type IDefinition interface

+ SwgenDefinition func() (typeName string, typeDef SchemaObj, err error)

+ type IParameter interface

+ SwgenParameter func() (name string, params []ParamObj, err error)

+ type InfoObj struct

+ Contact ContactObj

+ Description string

+ License LicenseObj

+ TermsOfService string

+ Title string

+ Version string

+ type LicenseObj struct

+ Name string

+ URL string

+ type OperationObj struct

+ Deprecated bool

+ Description string

+ Parameters []ParamObj

+ Responses Responses

+ Summary string

+ Tags []string

+ func (ad *OperationObj) AddExtendedField(name string, value interface{})

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

+ type ParamItemObj struct

+ CollectionFormat string

+ Format string

+ Items *ParamItemObj

+ Ref string

+ Type string

+ type ParamObj struct

+ CollectionFormat string

+ Default interface{}

+ Description string

+ Format string

+ In string

+ Items *ParamItemObj

+ Name string

+ Ref string

+ Required bool

+ Schema *SchemaObj

+ Type string

+ func ParseParameter(i interface{}) (name string, params []ParamObj, err error)

+ type PathItem struct

+ Delete *OperationObj

+ Get *OperationObj

+ Head *OperationObj

+ Options *OperationObj

+ Params *ParamObj

+ Patch *OperationObj

+ Post *OperationObj

+ Put *OperationObj

+ Ref string

+ func (pi PathItem) HasMethod(method string) bool

+ type PathItemInfo struct

+ Deprecated bool

+ Description string

+ Method string

+ Path string

+ Tag string

+ Title string

+ func (ad *PathItemInfo) AddExtendedField(name string, value interface{})

+ type ResponseObj struct

+ Description string

+ Examples interface{}

+ Headers interface{}

+ Ref string

+ Schema *SchemaObj

+ type Responses map[string]ResponseObj

+ type SchemaObj struct

+ AdditionalProperties *SchemaObj

+ Default interface{}

+ Description string

+ Format string

+ Items *SchemaObj

+ Properties map[string]SchemaObj

+ Ref string

+ Title string

+ Type string

+ TypeName string

+ func ParseDefinition(i interface{}) (typeDef SchemaObj, err error)

+ type ServiceType string

+ const ServiceTypeJSONRPC

+ const ServiceTypeRest

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