swgen

May 27, 2020

Changes in this version

type SwaggerData

+ func (s SwaggerData) IgnoreTypeName()

Apr 14, 2020

Changes in this version

+ const SecurityBearerToken

+ func JSONSchemaInterceptType(v reflect.Value, s *jsonschema.Schema) (bool, error)

+ func LoadJSONSchemaFromSwgen(d SwaggerData, s *jsonschema.Schema)

type Generator

+ func (g *Generator) SetOAS3Proxy(oas3Proxy *openapi3.Reflector)

type SecurityDef

+ BearerFormat string

Mar 11, 2020

Changes in this version

type PathItemInfo

+ func (p *PathItemInfo) Responses() map[int]interface{}

Mar 28, 2019

Changes in this version

type SchemaObj

+ Required []string

Feb 5, 2019

Changes in this version

type OperationObj

+ Consumes []string

+ Produces []string

type PathItemInfo

+ Consumes []string

+ Produces []string

Jan 21, 2019

Changes in this version

type Generator

+ func (g *Generator) GetJSONSchemaRequestBody(op *OperationObj, cfg ...JSONSchemaConfig) (map[string]interface{}, error)

+ func (g *Generator) WalkJSONSchemaRequestBodies(function func(path, method string, schema map[string]interface{})) error

Jan 18, 2019

Changes in this version

type Generator

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

Dec 20, 2018

Changes in this version

type Generator

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

Dec 10, 2018

Changes in this version

+ type CommonFields struct

+ Default interface{}

+ Description string

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Format string

+ MaxItems int64

+ MaxLength int64

+ MaxProperties int64

+ Maximum float64

+ MinItems int64

+ MinLength int64

+ MinProperties int64

+ Minimum float64

+ MultipleOf float64

+ Pattern string

+ Title string

+ Type string

+ UniqueItems bool

Dec 7, 2018

Changes in this version

+ type SchemaDefinitionFunc func() SwaggerData

+ func (f SchemaDefinitionFunc) SwaggerDef() SwaggerData

Nov 8, 2018

Changes in this version

type Enum

+ func (enum *Enum) LoadFromField(field reflect.StructField)

Nov 6, 2018

Changes in this version

+ const APIKeyInHeader

+ const APIKeyInQuery

+ const CommonNameBinary

+ const CommonNameBoolean

+ const CommonNameByte

+ const CommonNameDate

+ const CommonNameDateTime

+ const CommonNameDouble

+ const CommonNameFloat

+ const CommonNameInteger

+ const CommonNameLong

+ const CommonNamePassword

+ const CommonNameString

+ const Oauth2AccessCode

+ const Oauth2Application

+ const Oauth2Implicit

+ const Oauth2Password

+ const SecurityAPIKey

+ const SecurityBasicAuth

+ const SecurityOAuth2

+ func IsSlice(i interface{}) bool

+ func IsStruct(i interface{}) bool

+ func ObjectHasXFields(i interface{}, tagname string) bool

+ func ReflectTypeHash(t reflect.Type) uint32

+ func ReflectTypeReliableName(t reflect.Type) string

+ 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

+ SecurityDefinitions map[string]SecurityDef

+ 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 NewGenerator() *Generator

+ func (g *Generator) AddDefaultResponse(httpCode int, response interface{})

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

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

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

+ func (g *Generator) Document() Document

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

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

+ func (g *Generator) GetJSONSchemaRequestGroups(op *OperationObj, cfg ...JSONSchemaConfig) (map[string]ObjectJSONSchema, error)

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

+ func (g *Generator) JSONSchema(s SchemaObj, option ...JSONSchemaConfig) (map[string]interface{}, error)

+ func (g *Generator) ParamJSONSchema(p ParamObj, cfg ...JSONSchemaConfig) (map[string]interface{}, error)

+ func (g *Generator) ParseDefinition(i interface{}) SchemaObj

+ func (g *Generator) ParseParameters(i interface{}) (string, []ParamObj)

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

+ func (g *Generator) ResetDefinitions()

+ func (g *Generator) ResetPaths()

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

+ 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) *OperationObj

+ func (g *Generator) WalkJSONSchemaRequestGroups(function func(path, method, in string, schema ObjectJSONSchema)) error

+ func (g *Generator) WalkJSONSchemaResponses(...) error

+ type InfoObj struct

+ Contact ContactObj

+ Description string

+ License LicenseObj

+ TermsOfService string

+ Title string

+ Version string

+ type JSONSchemaConfig struct

+ CollectDefinitions map[string]map[string]interface{}

+ DefinitionsPrefix string

+ StripDefinitions bool

+ type LicenseObj struct

+ Name string

+ URL string

+ type ObjectJSONSchema struct

+ ID string

+ Properties map[string]map[string]interface{}

+ Required []string

+ Schema string

+ Type string

+ func (o ObjectJSONSchema) ToMap() (map[string]interface{}, error)

+ type OperationObj struct

+ Deprecated bool

+ Description string

+ Parameters []ParamObj

+ Responses Responses

+ Security []map[string][]string

+ 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

+ In string

+ Items *ParamItemObj

+ Name string

+ Required bool

+ Schema *SchemaObj

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

+ func (o ParamObj) MarshalJSON() ([]byte, 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

+ func (pi PathItem) Map() map[string]*OperationObj

+ type PathItemInfo struct

+ Deprecated bool

+ Description string

+ Method string

+ Path string

+ Request interface{}

+ Response interface{}

+ Security []string

+ SecurityOAuth2 map[string][]string

+ SuccessfulResponseCode int

+ Tag string

+ Title string

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

+ func (p *PathItemInfo) AddResponse(statusCode int, output interface{}) *PathItemInfo

+ func (p *PathItemInfo) AddResponses(responses ...WithStatusCode)

+ func (p *PathItemInfo) RemoveResponse(statusCode int) bool

+ type ResponseObj struct

+ Description string

+ Examples interface{}

+ Headers interface{}

+ Ref string

+ Schema *SchemaObj

+ type Responses map[int]ResponseObj

+ type SchemaDefinition interface

+ SwaggerDef func() SwaggerData

+ type SchemaObj struct

+ AdditionalProperties *SchemaObj

+ Example interface{}

+ GoPropertyNames map[string]string

+ GoPropertyTypes map[string]string

+ GoType string

+ Items *SchemaObj

+ Nullable bool

+ Properties map[string]SchemaObj

+ Ref string

+ Title string

+ TypeName string

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

+ func SchemaFromCommonName(name commonName) SchemaObj

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

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

+ func (so SchemaObj) Export() SchemaObj

+ type SecurityDef struct

+ AuthorizationURL string

+ Description string

+ Flow oauthFlow

+ In apiKeyIn

+ Name string

+ Scopes map[string]string

+ TokenURL string

+ Type securityType

+ type ServiceType string

+ const ServiceTypeJSONRPC

+ const ServiceTypeRest

+ type SwaggerData struct

+ func (s SwaggerData) Param() ParamObj

+ func (s SwaggerData) Schema() SchemaObj

+ func (s SwaggerData) SwaggerDef() SwaggerData

+ type WithStatusCode interface

+ StatusCode func() int