Documentation
¶
Index ¶
- Constants
- func ParseStatusErrMsg(s string) (string, bool)
- type DefinitionScanner
- type EnumScanner
- type Operator
- type OperatorScanner
- type OperatorWithTypeName
- type Route
- type Router
- func (router *Router) AppendOperators(operators ...*OperatorWithTypeName)
- func (router *Router) Name() string
- func (router *Router) Register(r *Router)
- func (router *Router) Route() *Route
- func (router *Router) Routes() (routes []*Route)
- func (router *Router) String() string
- func (router *Router) With(operators ...*OperatorWithTypeName)
- type RouterScanner
- func (scanner *RouterScanner) OperatorScanner() *OperatorScanner
- func (scanner *RouterScanner) OperatorTypeNameFromType(typ types.Type) *OperatorWithTypeName
- func (scanner *RouterScanner) OperatorTypeNamesFromArgs(pkg *packagex.Package, args ...ast.Expr) []*OperatorWithTypeName
- func (scanner *RouterScanner) Router(typeName *types.Var) *Router
- type SchemaRefer
- type StatusErrScanner
- type StatusErrorScanner
- type StructFieldUniqueChecker
- type VendorExtensible
Constants ¶
View Source
const ( XID = "x-id" XGoVendorType = `x-go-vendor-type` XGoStarLevel = `x-go-star-level` XGoFieldName = `x-go-field-name` XTagValidate = `x-tag-validate` XTagMime = `x-tag-mime` XTagJSON = `x-tag-json` XTagXML = `x-tag-xml` XTagName = `x-tag-name` XEnumOptions = `x-enum-options` XStatusErrs = `x-status-errors` )
Variables ¶
This section is empty.
Functions ¶
func ParseStatusErrMsg ¶
Types ¶
type DefinitionScanner ¶
type DefinitionScanner struct {
// contains filtered or unexported fields
}
func NewDefinitionScanner ¶
func NewDefinitionScanner(pkg *packagex.Package) *DefinitionScanner
func (*DefinitionScanner) BindSchemas ¶
func (scanner *DefinitionScanner) BindSchemas(openapi *oas.OpenAPI)
func (*DefinitionScanner) Def ¶
func (scanner *DefinitionScanner) Def(typeName *types.TypeName) *oas.Schema
func (*DefinitionScanner) GetSchemaByType ¶
func (scanner *DefinitionScanner) GetSchemaByType(typ types.Type) *oas.Schema
type EnumScanner ¶
type EnumScanner struct {
EnumSet map[*types.TypeName][]enumeration.EnumOption
// contains filtered or unexported fields
}
func NewEnumScanner ¶
func NewEnumScanner(pkg *packagex.Package) *EnumScanner
func (*EnumScanner) Enum ¶
func (scanner *EnumScanner) Enum(typeName *types.TypeName) []enumeration.EnumOption
type Operator ¶
type Operator struct {
transport_http.RouteMeta
Tag string
Description string
NonBodyParameters map[string]*oas.Parameter
RequestBody *oas.RequestBody
StatusErrors []*status_error.StatusError
StatusErrorSchema *oas.Schema
SuccessStatus int
SuccessType types.Type
SuccessResponse *oas.Response
}
func (*Operator) AddNonBodyParameter ¶
func (*Operator) BindOperation ¶
func (*Operator) SetRequestBody ¶
func (operator *Operator) SetRequestBody(requestBody *oas.RequestBody)
type OperatorScanner ¶
type OperatorScanner struct {
*DefinitionScanner
*StatusErrScanner
// contains filtered or unexported fields
}
func NewOperatorScanner ¶
func NewOperatorScanner(pkg *packagex.Package) *OperatorScanner
type OperatorWithTypeName ¶
func (*OperatorWithTypeName) String ¶
func (operator *OperatorWithTypeName) String() string
type Route ¶
type Route struct {
Operators []*OperatorWithTypeName
// contains filtered or unexported fields
}
type Router ¶
type Router struct {
// contains filtered or unexported fields
}
func (*Router) AppendOperators ¶
func (router *Router) AppendOperators(operators ...*OperatorWithTypeName)
func (*Router) With ¶
func (router *Router) With(operators ...*OperatorWithTypeName)
type RouterScanner ¶
type RouterScanner struct {
// contains filtered or unexported fields
}
func NewRouterScanner ¶
func NewRouterScanner(pkg *packagex.Package) *RouterScanner
func (*RouterScanner) OperatorScanner ¶
func (scanner *RouterScanner) OperatorScanner() *OperatorScanner
func (*RouterScanner) OperatorTypeNameFromType ¶
func (scanner *RouterScanner) OperatorTypeNameFromType(typ types.Type) *OperatorWithTypeName
func (*RouterScanner) OperatorTypeNamesFromArgs ¶
func (scanner *RouterScanner) OperatorTypeNamesFromArgs(pkg *packagex.Package, args ...ast.Expr) []*OperatorWithTypeName
type SchemaRefer ¶
func NewSchemaRefer ¶
func NewSchemaRefer(s *oas.Schema) *SchemaRefer
func (SchemaRefer) RefString ¶
func (r SchemaRefer) RefString() string
type StatusErrScanner ¶
type StatusErrScanner struct {
StatusErrType *types.Named
// contains filtered or unexported fields
}
func NewStatusErrScanner ¶
func NewStatusErrScanner(pkg *packagex.Package) *StatusErrScanner
func (*StatusErrScanner) StatusErrorsInFunc ¶
func (scanner *StatusErrScanner) StatusErrorsInFunc(typeFunc *types.Func) []*status_error.StatusError
type StatusErrorScanner ¶
type StatusErrorScanner struct {
StatusErrors map[*types.TypeName][]*status_error.StatusError
// contains filtered or unexported fields
}
func NewStatusErrorScanner ¶
func NewStatusErrorScanner(pkg *packagex.Package) *StatusErrorScanner
func (*StatusErrorScanner) StatusError ¶
func (scanner *StatusErrorScanner) StatusError(typeName *types.TypeName) []*status_error.StatusError
type VendorExtensible ¶
type VendorExtensible interface {
AddExtension(key string, value interface{})
}
Click to show internal directories.
Click to hide internal directories.