Documentation
¶
Index ¶
- func Assign(to, from string, isNew bool) string
- func ExecuteTemplate(name string, data any) (string, error)
- func NewComponents(spec specification.Components, cfg Config) (zero Components, _ Imports, _ error)
- func NewCustomType(s string, baseSchema SchemaType) (CustomType, Imports)
- func NewHandler(o *Operation, basePathPrefix string, cfg Config) (zero *Handler, _ Imports, _ error)
- func NewHandlerHeaderParameter(p *HeaderParameter, cfg Config) (zero HandlerHeaderParameter, _ Imports, _ error)
- func NewHandlerParameters(p OperationParams, cfg Config) (zero HandlerParameters, _ Imports, _ error)
- func NewHandlerPathParameter(p *PathParameter) (zero HandlerPathParameter, _ Imports, _ error)
- func NewHandlerQueryParameter(p *QueryParameter, cfg Config) (zero HandlerQueryParameter, _ Imports, _ error)
- func NewHeaderParameter(sr specification.Ref[specification.HeaderParameter], components Components) (zero *HeaderParameter, _ Imports, _ error)
- func NewOperation(s *specification.Operation, componenets Components, cfg Config) (zero *Operation, _ Imports, _ error)
- func NewOperationParams(params specification.OperationParameters, components Components) (zero OperationParams, _ Imports, _ error)
- func NewPathParameter(rs specification.Ref[specification.PathParameter], componenets Components) (zero *PathParameter, _ Imports, _ error)
- func NewQueryParameter(refP specification.Ref[specification.QueryParameter], components Components) (zero *QueryParameter, _ Imports, _ error)
- func NewResponse(handlerName OperationName, status string, response *specification.Response, ...) (*Response, Imports, error)
- func NewResponseHeader(name string, ref specification.Ref[specification.Header], ...) (zero ResponseHeader, _ Imports, _ error)
- func NewSchema(s specification.Ref[specification.Schema], components Components) (SchemaType, Imports, error)
- func NewStructureField(s specification.SchemaProperty, components Components) (zero StructureField, _ Imports, _ error)
- func NewStructureType(s *specification.Schema, components Components) (zero StructureType, _ Imports, _ error)
- func PrivateFieldName(name string) string
- func PublicFieldName(name string) string
- func Title(s string) string
- type BoolType
- func (b BoolType) Base() SchemaType
- func (b BoolType) ParseString(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (b BoolType) ParseStrings(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (b BoolType) Render() (string, error)
- func (b BoolType) RenderFormat(from string) (string, error)
- func (b BoolType) RenderFormatStrings(to, from string, isNew bool) (string, error)
- type ClientOperationHeaderTemplate
- type ClientOperationQueryTemplate
- type ClientOperationTemplate
- type ClientResponseHeaderTemplate
- type ClientResponseTemplate
- type ClientTemplate
- type Components
- type Config
- type CookieParameter
- type CustomType
- func (c CustomType) Base() SchemaType
- func (c CustomType) IsMultivalue() bool
- func (c CustomType) ParseString(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (c CustomType) ParseStrings(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (c CustomType) Render() (string, error)
- func (c CustomType) RenderFormat(from string) (string, error)
- func (c CustomType) RenderFormatStrings(to, from string, isNew bool) (string, error)
- type ErrorRender
- type FloatType
- func (f FloatType) Base() SchemaType
- func (i FloatType) ParseString(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (i FloatType) ParseStrings(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (f FloatType) Render() (string, error)
- func (i FloatType) RenderFormat(from string) (string, error)
- func (i FloatType) RenderFormatStrings(to, from string, isNew bool) (string, error)
- type Formatter
- type FormatterFunc
- type GenOption
- type Generator
- type GeneratorOptions
- type GoFile
- type Handler
- type HandlerHeaderParameter
- type HandlerParameter
- type HandlerParameterHeaderTemplate
- type HandlerParameterPathTemplate
- type HandlerParameterQueryTemplate
- type HandlerParameterTemplate
- type HandlerParameters
- type HandlerPathParameter
- type HandlerQueryParameter
- type HandlerResponse
- type HandlerResponseTemplate
- type HandlerTemplate
- type HandlersFileTemplate
- type HeaderComponent
- type HeaderParameter
- type Import
- type Imports
- type IntType
- func (i IntType) Base() SchemaType
- func (i IntType) ParseString(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (i IntType) ParseStrings(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (i IntType) Render() (string, error)
- func (i IntType) RenderFormat(from string) (string, error)
- func (i IntType) RenderFormatStrings(to, from string, isNew bool) (string, error)
- type MapType
- func (m MapType) Base() SchemaType
- func (m MapType) ParseString(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (m MapType) ParseStrings(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (m MapType) Render() (string, error)
- func (m MapType) RenderFormat(from string) (string, error)
- func (m MapType) RenderFormatStrings(to, from string, isNew bool) (string, error)
- type MappedList
- type Maybe
- type Multivalue
- type Operation
- type OperationName
- type OperationParams
- type OperationPathElement
- type OptionalType
- func (o OptionalType) Base() SchemaType
- func (p OptionalType) IsMultivalue() bool
- func (p OptionalType) ParseString(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (p OptionalType) ParseStrings(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (p OptionalType) Render() (string, error)
- func (p OptionalType) RenderFormat(from string) (string, error)
- func (p OptionalType) RenderFormatStrings(to, from string, isNew bool) (string, error)
- type Parser
- type ParserFunc
- type Path
- type PathItem
- type PathParameter
- type PathParameters
- type PathParserConstant
- type PathParserVariable
- type PathStringBuilder
- type PathV
- type QueryParameter
- type QuotedRender
- type RefSchemaType
- func (r RefSchemaType) Base() SchemaType
- func (r RefSchemaType) IsMultivalue() bool
- func (r RefSchemaType) ParseString(to, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (r RefSchemaType) ParseStrings(to, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (r RefSchemaType) Render() (string, error)
- func (r RefSchemaType) RenderFormat(from string) (string, error)
- func (r RefSchemaType) RenderFormatStrings(to, from string, isNew bool) (string, error)
- type Render
- type RenderFunc
- type Renders
- type RequestBodyComponent
- type Response
- type ResponseArg
- type ResponseCode
- type ResponseComponent
- type ResponseHeader
- type ResponseUsedIn
- type Route
- type RoutePathItem
- type Router
- type RouterPathItem
- type RouterPathItemOperation
- type Schema
- type SchemaComponent
- type SchemaType
- type SingleValue
- type SliceType
- func (s SliceType) Base() SchemaType
- func (s SliceType) ParseString(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (s SliceType) ParseStrings(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (s SliceType) Render() (string, error)
- func (s SliceType) RenderFormat(from string) (string, error)
- func (s SliceType) RenderFormatStrings(to, from string, isNew bool) (string, error)
- func (s SliceType) RenderFormatStringsMultiline(to, from string) (string, error)
- type StringRender
- type StringType
- func (s StringType) Base() SchemaType
- func (_ StringType) ParseString(to, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (_ StringType) ParseStrings(to, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (s StringType) Render() (string, error)
- func (_ StringType) RenderFormat(from string) (string, error)
- func (s StringType) RenderFormatStrings(to, from string, isNew bool) (string, error)
- type StructureField
- type StructureFieldTag
- type StructureType
- func (s StructureType) Base() SchemaType
- func (s StructureType) ParseString(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (s StructureType) ParseStrings(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
- func (s StructureType) Render() (string, error)
- func (s StructureType) RenderFormat(from string) (string, error)
- func (s StructureType) RenderFormatStrings(to, from string, isNew bool) (string, error)
- type TData
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewComponents ¶
func NewComponents(spec specification.Components, cfg Config) (zero Components, _ Imports, _ error)
func NewCustomType ¶ added in v0.0.8
func NewCustomType(s string, baseSchema SchemaType) (CustomType, Imports)
func NewHandler ¶
func NewHandlerHeaderParameter ¶ added in v0.1.0
func NewHandlerHeaderParameter(p *HeaderParameter, cfg Config) (zero HandlerHeaderParameter, _ Imports, _ error)
func NewHandlerParameters ¶ added in v0.1.0
func NewHandlerParameters(p OperationParams, cfg Config) (zero HandlerParameters, _ Imports, _ error)
func NewHandlerPathParameter ¶ added in v0.1.0
func NewHandlerPathParameter(p *PathParameter) (zero HandlerPathParameter, _ Imports, _ error)
func NewHandlerQueryParameter ¶ added in v0.1.0
func NewHandlerQueryParameter(p *QueryParameter, cfg Config) (zero HandlerQueryParameter, _ Imports, _ error)
func NewHeaderParameter ¶ added in v0.0.2
func NewHeaderParameter(sr specification.Ref[specification.HeaderParameter], components Components) (zero *HeaderParameter, _ Imports, _ error)
func NewOperation ¶ added in v0.0.2
func NewOperation(s *specification.Operation, componenets Components, cfg Config) (zero *Operation, _ Imports, _ error)
func NewOperationParams ¶ added in v0.0.14
func NewOperationParams(params specification.OperationParameters, components Components) (zero OperationParams, _ Imports, _ error)
func NewPathParameter ¶
func NewPathParameter(rs specification.Ref[specification.PathParameter], componenets Components) (zero *PathParameter, _ Imports, _ error)
func NewQueryParameter ¶ added in v0.0.2
func NewQueryParameter(refP specification.Ref[specification.QueryParameter], components Components) (zero *QueryParameter, _ Imports, _ error)
func NewResponse ¶
func NewResponse(handlerName OperationName, status string, response *specification.Response, components Components, cfg Config) (*Response, Imports, error)
func NewResponseHeader ¶ added in v0.1.0
func NewResponseHeader(name string, ref specification.Ref[specification.Header], components Components, cfg Config) (zero ResponseHeader, _ Imports, _ error)
func NewSchema ¶
func NewSchema(s specification.Ref[specification.Schema], components Components) (SchemaType, Imports, error)
func NewStructureField ¶ added in v0.0.11
func NewStructureField(s specification.SchemaProperty, components Components) (zero StructureField, _ Imports, _ error)
func NewStructureType ¶ added in v0.0.11
func NewStructureType(s *specification.Schema, components Components) (zero StructureType, _ Imports, _ error)
func PrivateFieldName ¶
func PublicFieldName ¶
Types ¶
type BoolType ¶ added in v0.0.10
type BoolType struct {
SingleValue
}
func (BoolType) Base ¶ added in v0.1.23
func (b BoolType) Base() SchemaType
func (BoolType) ParseString ¶ added in v0.1.0
func (BoolType) ParseStrings ¶ added in v0.1.21
func (BoolType) RenderFormat ¶ added in v0.0.10
type ClientOperationHeaderTemplate ¶ added in v0.1.19
type ClientOperationQueryTemplate ¶ added in v0.1.19
type ClientOperationTemplate ¶ added in v0.1.19
type ClientOperationTemplate struct {
Name OperationName
Description string
HTTPMethod specification.HTTPMethod
Method specification.HTTPMethodTitle
PathRaw string
PathParams []PathStringBuilder
RequestTypeName string
ResponseTypeName string
Queries []ClientOperationQueryTemplate
Headers []ClientOperationHeaderTemplate
IsRequestBody bool
Responses []ClientResponseTemplate
DefaultResponse *ClientResponseTemplate
}
func NewClientOperation ¶ added in v0.0.14
func NewClientOperation(o *Operation) ClientOperationTemplate
func (ClientOperationTemplate) Render ¶ added in v0.1.19
func (c ClientOperationTemplate) Render() (string, error)
type ClientResponseHeaderTemplate ¶ added in v0.1.19
type ClientResponseHeaderTemplate struct {
Key string
Required bool
SchemaParseStrings ParserFunc
FieldName string
}
type ClientResponseTemplate ¶ added in v0.1.19
type ClientResponseTemplate struct {
Name string
StatusCode string
ComponentRefName string
Headers []ClientResponseHeaderTemplate
ContentJSON bool
}
func (ClientResponseTemplate) Render ¶ added in v0.1.19
func (c ClientResponseTemplate) Render() (string, error)
type ClientTemplate ¶ added in v0.1.19
type ClientTemplate struct {
Operations []ClientOperationTemplate
}
func NewClient ¶ added in v0.0.2
func NewClient(s *specification.Spec, ops []*Operation) ClientTemplate
func (ClientTemplate) Render ¶ added in v0.1.19
func (c ClientTemplate) Render() (string, error)
type Components ¶
type Components struct {
Schemas *MappedList[specification.Ref[specification.Schema], SchemaComponent]
Headers []HeaderComponent
RequestBodies []RequestBodyComponent
Responses []ResponseComponent
HasContentJSON bool
}
func (Components) LenToRender ¶ added in v0.1.21
func (c Components) LenToRender() int
func (Components) Render ¶ added in v0.1.0
func (c Components) Render() (string, error)
type Config ¶ added in v0.1.7
type Config struct {
Maybe struct {
Import string `yaml:"import"`
Type string `yaml:"type"`
} `yaml:"maybe"`
Cors struct {
Enable bool `yaml:"enable"`
} `yaml:"cors"`
CustomTypes struct {
Ignore bool `yaml:"ignore"`
} `yaml:"customTypes"`
}
func LoadConfig ¶ added in v0.1.7
type CookieParameter ¶ added in v0.0.14
type CookieParameter struct {
specification.CookieParameter
}
type CustomType ¶ added in v0.0.5
type CustomType struct {
Type string
Import string
BaseType SchemaType
}
func (CustomType) Base ¶ added in v0.1.15
func (c CustomType) Base() SchemaType
func (CustomType) IsMultivalue ¶ added in v0.1.23
func (c CustomType) IsMultivalue() bool
func (CustomType) ParseString ¶ added in v0.1.0
func (c CustomType) ParseString(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
func (CustomType) ParseStrings ¶ added in v0.1.21
func (c CustomType) ParseStrings(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
func (CustomType) Render ¶ added in v0.0.11
func (c CustomType) Render() (string, error)
func (CustomType) RenderFormat ¶ added in v0.0.11
func (c CustomType) RenderFormat(from string) (string, error)
func (CustomType) RenderFormatStrings ¶ added in v0.1.19
func (c CustomType) RenderFormatStrings(to, from string, isNew bool) (string, error)
type ErrorRender ¶ added in v0.0.10
type FloatType ¶ added in v0.0.10
type FloatType struct {
SingleValue
BitSize int
}
func (FloatType) Base ¶ added in v0.1.23
func (f FloatType) Base() SchemaType
func (FloatType) ParseString ¶ added in v0.1.0
func (FloatType) ParseStrings ¶ added in v0.1.21
func (FloatType) RenderFormat ¶ added in v0.0.10
type Formatter ¶ added in v0.0.10
type Formatter interface {
RenderFormat(from string) (string, error)
RenderFormatStrings(to, from string, isNew bool) (string, error)
}
Formatter formats 'string' from '<type>'.
type FormatterFunc ¶ added in v0.0.10
func (FormatterFunc) RenderFormat ¶ added in v0.0.10
func (f FormatterFunc) RenderFormat(from string) (string, error)
type GenOption ¶ added in v0.0.2
type GenOption interface {
// contains filtered or unexported methods
}
func PackageName ¶ added in v0.0.2
func SkipDoNotEdit ¶ added in v0.0.2
func SkipDoNotEdit() GenOption
func SpecFilename ¶ added in v0.0.14
type Generator ¶ added in v0.0.2
type Generator struct {
Options GeneratorOptions
Spec *specification.Spec
Imports Imports
Operations []*Operation
Paths []*PathItem
Client ClientTemplate
Components Components
Router Router
HandlersFile HandlersFileTemplate
Handlers []*Handler
IsWriteJSONFunc bool
}
func NewGenerator ¶ added in v0.0.2
func (*Generator) ClientFile ¶ added in v0.0.2
func (*Generator) ComponentsFile ¶ added in v0.1.0
func (*Generator) HandlerFile ¶ added in v0.1.0
func (*Generator) RouterFile ¶ added in v0.0.2
type GeneratorOptions ¶ added in v0.0.14
type Handler ¶
type Handler struct {
*Operation
HandlerFuncName string
BasePathPrefix string
CanParseError bool
Parameters HandlerParameters
PathParsers []Parser
DefaultResponse *HandlerResponse
Responses []HandlerResponse
}
type HandlerHeaderParameter ¶ added in v0.1.0
type HandlerHeaderParameter struct {
HandlerParameter
ParameterName string
Required bool
Parser Parser
}
type HandlerParameter ¶ added in v0.1.0
func (HandlerParameter) Render ¶ added in v0.1.0
func (h HandlerParameter) Render() (string, error)
type HandlerParameterHeaderTemplate ¶ added in v0.1.23
type HandlerParameterHeaderTemplate struct {
HandlerParameter HandlerParameterTemplate
ParameterName string
Required bool
Parser Parser
}
func NewHandlerParameterHeaderTemplate ¶ added in v0.1.23
func NewHandlerParameterHeaderTemplate(p HandlerHeaderParameter) HandlerParameterHeaderTemplate
func NewHandlerParameterHeaderTemplates ¶ added in v0.1.23
func NewHandlerParameterHeaderTemplates(ps []HandlerHeaderParameter) []HandlerParameterHeaderTemplate
type HandlerParameterPathTemplate ¶ added in v0.1.23
type HandlerParameterPathTemplate struct {
HandlerParameter HandlerParameterTemplate
}
func NewHandlerParameterPathTemplate ¶ added in v0.1.23
func NewHandlerParameterPathTemplate(p HandlerPathParameter) HandlerParameterPathTemplate
func NewHandlerParameterPathTemplates ¶ added in v0.1.23
func NewHandlerParameterPathTemplates(ps []HandlerPathParameter) []HandlerParameterPathTemplate
type HandlerParameterQueryTemplate ¶ added in v0.1.23
type HandlerParameterQueryTemplate struct {
HandlerParameter HandlerParameterTemplate
ParameterName string
Required bool
IsOptional bool
ParseStrings func(to, from string, isNew bool, mkErr ErrorRender) (string, error)
}
func NewHandlerParameterQueryTemplate ¶ added in v0.1.23
func NewHandlerParameterQueryTemplate(p HandlerQueryParameter) HandlerParameterQueryTemplate
func NewHandlerParameterQueryTemplates ¶ added in v0.1.23
func NewHandlerParameterQueryTemplates(ps []HandlerQueryParameter) []HandlerParameterQueryTemplate
type HandlerParameterTemplate ¶ added in v0.1.23
func NewHandlerParameterTemplate ¶ added in v0.1.23
func NewHandlerParameterTemplate(h HandlerParameter) HandlerParameterTemplate
func (HandlerParameterTemplate) Render ¶ added in v0.1.23
func (t HandlerParameterTemplate) Render() (string, error)
type HandlerParameters ¶ added in v0.1.0
type HandlerParameters struct {
Query []HandlerQueryParameter
Path []HandlerPathParameter
Header []HandlerHeaderParameter
}
type HandlerPathParameter ¶ added in v0.1.0
type HandlerPathParameter struct {
HandlerParameter
ParameterName string
Parser Parser
}
type HandlerQueryParameter ¶ added in v0.1.0
type HandlerQueryParameter struct {
HandlerParameter
ParameterName string
Required bool
IsOptional bool
Parser Parser
}
func (HandlerQueryParameter) ParseStrings ¶ added in v0.1.0
func (p HandlerQueryParameter) ParseStrings(to, from string, isNew bool, mkErr ErrorRender) (string, error)
type HandlerResponse ¶ added in v0.1.0
type HandlerResponse struct {
*Response
Name string
// PrivateName string
HandlerName OperationName
Status string
IsDefault bool
UsedIn []ResponseUsedIn
IsBody bool
BodyTypeName Render
Body Render
BodyRenders Renders
ContentType string
Struct StructureType
Args []ResponseArg
}
func NewHandlerResponse ¶ added in v0.1.0
func NewHandlerResponse(r *Response, name OperationName, status string, ifaceNames ...ResponseUsedIn) HandlerResponse
func (HandlerResponse) Render ¶ added in v0.1.0
func (h HandlerResponse) Render() (string, error)
type HandlerResponseTemplate ¶ added in v0.1.23
type HandlerResponseTemplate struct {
Name string
Description string
HandlerName OperationName
Status string
IsDefault bool
UsedIn []ResponseUsedIn
IsBody bool
BodyTypeName Render
Body Render
BodyRenders Renders
ContentType string
Struct StructureType
Args []ResponseArg
Headers []ResponseHeader
IsComponent bool
}
func NewHandlerResponseTemplate ¶ added in v0.1.23
func NewHandlerResponseTemplate(r HandlerResponse) HandlerResponseTemplate
func NewHandlerResponseTemplates ¶ added in v0.1.23
func NewHandlerResponseTemplates(rs []HandlerResponse) []HandlerResponseTemplate
func (HandlerResponseTemplate) Render ¶ added in v0.1.23
func (t HandlerResponseTemplate) Render() (string, error)
type HandlerTemplate ¶ added in v0.1.23
type HandlerTemplate struct {
Name OperationName
Description string
Summary string
HandlerFuncName string
BasePathPrefix string
CanParseError bool
ParametersQuery []HandlerParameterQueryTemplate
ParametersPath []HandlerParameterPathTemplate
ParametersHeader []HandlerParameterHeaderTemplate
BodyTypeName Render
BodyType Render
PathParsers []Parser
Responses []HandlerResponseTemplate
DefaultResponse Maybe[HandlerResponseTemplate]
}
func NewHandlerTemplate ¶ added in v0.1.23
func NewHandlerTemplate(h *Handler) HandlerTemplate
func (HandlerTemplate) Render ¶ added in v0.1.23
func (t HandlerTemplate) Render() (string, error)
type HandlersFileTemplate ¶ added in v0.1.23
type HandlersFileTemplate struct {
Handlers []HandlerTemplate
IsWriteJSONFunc bool
IsCustomMaybe bool
}
func NewHandlersFileTemplate ¶ added in v0.1.23
func NewHandlersFileTemplate(hs []*Handler, isWriteJSONFunc bool, cfg Config) HandlersFileTemplate
func (HandlersFileTemplate) Render ¶ added in v0.1.23
func (t HandlersFileTemplate) Render() (string, error)
type HeaderComponent ¶ added in v0.1.2
func (HeaderComponent) Render ¶ added in v0.1.2
func (s HeaderComponent) Render() (string, error)
type HeaderParameter ¶ added in v0.0.2
type IntType ¶ added in v0.0.2
type IntType struct {
SingleValue
BitSize int
}
func (IntType) Base ¶ added in v0.1.23
func (i IntType) Base() SchemaType
func (IntType) ParseString ¶ added in v0.1.0
func (IntType) ParseStrings ¶ added in v0.1.21
func (IntType) RenderFormat ¶ added in v0.0.10
type MapType ¶ added in v0.1.0
type MapType struct {
SingleValue
Key SchemaType
Value SchemaType
}
func NewMapType ¶ added in v0.1.0
func NewMapType(k, v SchemaType) MapType
func (MapType) Base ¶ added in v0.1.23
func (m MapType) Base() SchemaType
func (MapType) ParseString ¶ added in v0.1.0
func (MapType) ParseStrings ¶ added in v0.1.21
func (MapType) RenderFormat ¶ added in v0.1.0
type MappedList ¶ added in v0.1.23
type MappedList[I comparable, O any] struct { List []O // contains filtered or unexported fields }
func NewMappedList ¶ added in v0.1.23
func NewMappedList[I comparable, O any](m specification.Map[I]) *MappedList[I, O]
func (MappedList[I, O]) Get ¶ added in v0.1.23
func (m MappedList[I, O]) Get(v I) (*O, bool)
type Multivalue ¶ added in v0.1.4
type Multivalue struct{}
func (Multivalue) IsMultivalue ¶ added in v0.1.4
func (Multivalue) IsMultivalue() bool
type Operation ¶ added in v0.0.2
type Operation struct {
*specification.Operation
Name OperationName
Description string
Summary string
Path Path
PathBuilder []OperationPathElement
APIHandlerFieldName string
HandlerTypeName string
RequestTypeName string
ResponseTypeName string
Params OperationParams
Body struct {
TypeName Render
Type Render
}
DefaultResponse *ResponseCode
Responses []*ResponseCode
}
type OperationName ¶ added in v0.0.2
type OperationName string
func NewOperationName ¶ added in v0.0.14
func NewOperationName(method specification.HTTPMethodTitle, s *specification.Operation, path Path) OperationName
type OperationParams ¶ added in v0.0.14
type OperationParams struct {
Query specification.Map[*QueryParameter]
Headers specification.Map[*HeaderParameter]
Path specification.Map[*PathParameter]
Cookie specification.Map[*CookieParameter]
}
type OperationPathElement ¶ added in v0.1.0
type OperationPathElement struct {
Raw string
Param Maybe[*PathParameter]
}
type OptionalType ¶ added in v0.1.5
type OptionalType struct {
V SchemaType
MaybeType string
}
func NewOptionalType ¶ added in v0.1.5
func NewOptionalType(v SchemaType, cfg Config) OptionalType
func (OptionalType) Base ¶ added in v0.1.23
func (o OptionalType) Base() SchemaType
func (OptionalType) IsMultivalue ¶ added in v0.1.5
func (p OptionalType) IsMultivalue() bool
func (OptionalType) ParseString ¶ added in v0.1.5
func (p OptionalType) ParseString(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
func (OptionalType) ParseStrings ¶ added in v0.1.21
func (p OptionalType) ParseStrings(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
func (OptionalType) Render ¶ added in v0.1.5
func (p OptionalType) Render() (string, error)
func (OptionalType) RenderFormat ¶ added in v0.1.5
func (p OptionalType) RenderFormat(from string) (string, error)
func (OptionalType) RenderFormatStrings ¶ added in v0.1.21
func (p OptionalType) RenderFormatStrings(to, from string, isNew bool) (string, error)
type Parser ¶ added in v0.0.10
type Parser interface {
ParseString(to, from string, isNew bool, mkErr ErrorRender) (string, error)
IsMultivalue() bool
ParseStrings(to, from string, isNew bool, mkErr ErrorRender) (string, error)
}
Parser parses 'string' to '<type>'.
type ParserFunc ¶ added in v0.0.10
type ParserFunc func(to, from string, isNew bool, mkErr ErrorRender) (string, error)
func (ParserFunc) ParseString ¶ added in v0.1.0
func (p ParserFunc) ParseString(to, from string, isNew bool, mkErr ErrorRender) (string, error)
type Path ¶ added in v0.1.19
type Path struct {
Raw string
Dirs []*PathV
Parameters specification.Map[*PathV]
}
func (Path) StringBuilder ¶ added in v0.1.21
func (p Path) StringBuilder() []PathStringBuilder
type PathItem ¶
type PathItem struct {
*specification.PathItem
Operations []*Operation
}
type PathParameter ¶
type PathParameter struct {
Name string
FieldName string
FieldTypeName string
Type SchemaType
Description string
// contains filtered or unexported fields
}
type PathParameters ¶ added in v0.0.2
type PathParameters []*PathParameter
func (PathParameters) Get ¶ added in v0.0.2
func (s PathParameters) Get(name string) (zero *PathParameter, _ error)
type PathParserConstant ¶ added in v0.1.0
type PathParserConstant struct {
SingleValue
Prefix string
FullPath string
}
func (PathParserConstant) ParseString ¶ added in v0.1.0
func (p PathParserConstant) ParseString(_, _ string, _ bool, _ ErrorRender) (string, error)
func (PathParserConstant) ParseStrings ¶ added in v0.1.21
func (p PathParserConstant) ParseStrings(_, _ string, _ bool, _ ErrorRender) (string, error)
type PathParserVariable ¶ added in v0.1.0
type PathParserVariable struct {
SingleValue
FieldName string
Name string
Convert Parser
}
func (PathParserVariable) ParseString ¶ added in v0.1.0
func (p PathParserVariable) ParseString(to, from string, isNew bool, mkErr ErrorRender) (string, error)
func (PathParserVariable) ParseStrings ¶ added in v0.1.21
func (p PathParserVariable) ParseStrings(to, from string, isNew bool, mkErr ErrorRender) (string, error)
type PathStringBuilder ¶ added in v0.1.21
type PathStringBuilder struct {
Prefix string
Param *PathParameter
}
type PathV ¶ added in v0.1.19
type PathV struct {
V string
IsVariable bool
Param *PathParameter
}
type QueryParameter ¶ added in v0.0.2
type QueryParameter struct {
Name string
Description string
FieldName string
Required bool
Type SchemaType
}
type QuotedRender ¶ added in v0.0.14
type QuotedRender string
func (QuotedRender) Render ¶ added in v0.0.14
func (s QuotedRender) Render() (string, error)
type RefSchemaType ¶ added in v0.1.23
type RefSchemaType struct {
Name string
Ref *SchemaComponent
}
func NewRefSchemaType ¶ added in v0.1.23
func NewRefSchemaType(name string, next *SchemaComponent) RefSchemaType
func (RefSchemaType) Base ¶ added in v0.1.23
func (r RefSchemaType) Base() SchemaType
func (RefSchemaType) IsMultivalue ¶ added in v0.1.23
func (r RefSchemaType) IsMultivalue() bool
func (RefSchemaType) ParseString ¶ added in v0.1.23
func (r RefSchemaType) ParseString(to, from string, isNew bool, mkErr ErrorRender) (string, error)
func (RefSchemaType) ParseStrings ¶ added in v0.1.23
func (r RefSchemaType) ParseStrings(to, from string, isNew bool, mkErr ErrorRender) (string, error)
func (RefSchemaType) Render ¶ added in v0.1.23
func (r RefSchemaType) Render() (string, error)
func (RefSchemaType) RenderFormat ¶ added in v0.1.23
func (r RefSchemaType) RenderFormat(from string) (string, error)
func (RefSchemaType) RenderFormatStrings ¶ added in v0.1.23
func (r RefSchemaType) RenderFormatStrings(to, from string, isNew bool) (string, error)
type Render ¶
func BaseFuncName ¶ added in v0.1.23
func BaseFuncName(st SchemaType) Render
type RenderFunc ¶ added in v0.0.10
func (RenderFunc) Render ¶ added in v0.0.10
func (r RenderFunc) Render() (string, error)
type RequestBodyComponent ¶ added in v0.1.2
func (RequestBodyComponent) Render ¶ added in v0.1.2
func (s RequestBodyComponent) Render() (string, error)
type Response ¶
type Response struct {
*specification.Response
Name string
Headers []ResponseHeader
// Content specification.Map[specification.Ref[SchemaType]]
ContentJSON Maybe[Schema]
}
type ResponseArg ¶
type ResponseCode ¶ added in v0.1.8
type ResponseCode struct {
*Response
StatusCode string
ComponentRef *specification.Object[string, specification.Ref[specification.Response]]
}
type ResponseComponent ¶ added in v0.1.8
type ResponseComponent struct {
Name string
Description string
Alias string
IsComponent bool
HandlerResponse
}
func (ResponseComponent) Render ¶ added in v0.1.8
func (c ResponseComponent) Render() (string, error)
type ResponseHeader ¶
type ResponseUsedIn ¶ added in v0.1.8
type ResponseUsedIn struct {
OperationName OperationName
Status string
}
type Route ¶
type Route struct {
Name string
BasePath string
Prefix string
PrefixPathItems []*RoutePathItem
Variable *RoutePathItem
Routes []*Route
VariableRoute *Route
// contains filtered or unexported fields
}
func (*Route) Add ¶ added in v0.0.14
func (r *Route) Add(pi *RouterPathItem)
type RoutePathItem ¶ added in v0.0.14
type RoutePathItem struct {
*RouterPathItem
Prefix string
}
type Router ¶
type Router struct {
BasePath string
SpecFilename string
SpecFileExt string
PathItems []*RouterPathItem
Operations []*Operation
Routes []*Route
JWT bool
Cors bool
}
func NewRouter ¶
func NewRouter(s *specification.Spec, ps []*PathItem, os []*Operation, opt GeneratorOptions) Router
type RouterPathItem ¶ added in v0.0.14
type RouterPathItem struct {
RawPath string
Operations []RouterPathItemOperation
JWT bool
HasOptions bool
}
type RouterPathItemOperation ¶ added in v0.1.14
type RouterPathItemOperation struct {
Name OperationName
Method specification.HTTPMethodTitle
PathSpec string
Handler string
IsCORS bool
CORSMethods []string
CORSHeaders []string
}
type Schema ¶ added in v0.0.2
type Schema struct {
Spec specification.Ref[specification.Schema]
Type SchemaType
}
type SchemaComponent ¶ added in v0.0.11
type SchemaComponent struct {
Name string
Description string
Type SchemaType
IgnoreParseFormat bool
IsMultivalue bool
IsAlias bool
RenderFormatStringsMultiline func(to, from string) (string, error)
CustomJSONMarshaler bool
StructureType StructureType
Ref Maybe[*SchemaComponent]
BaseType Render
IsRef bool
}
func (SchemaComponent) Base ¶ added in v0.1.23
func (s SchemaComponent) Base() SchemaType
func (SchemaComponent) Render ¶ added in v0.1.0
func (s SchemaComponent) Render() (string, error)
type SchemaType ¶ added in v0.1.0
type SchemaType interface {
Base() SchemaType
Render
Parser
Formatter
}
type SingleValue ¶ added in v0.1.4
type SingleValue struct{}
func (SingleValue) IsMultivalue ¶ added in v0.1.4
func (SingleValue) IsMultivalue() bool
type SliceType ¶ added in v0.0.2
type SliceType struct {
Multivalue
Items SchemaType
}
func (SliceType) Base ¶ added in v0.1.23
func (s SliceType) Base() SchemaType
func (SliceType) ParseString ¶ added in v0.1.0
func (SliceType) ParseStrings ¶ added in v0.1.0
func (SliceType) RenderFormat ¶ added in v0.0.11
func (SliceType) RenderFormatStrings ¶ added in v0.1.21
type StringRender ¶ added in v0.0.10
type StringRender string
func (StringRender) Render ¶ added in v0.0.10
func (s StringRender) Render() (string, error)
type StringType ¶
type StringType struct {
SingleValue
}
func (StringType) Base ¶ added in v0.1.23
func (s StringType) Base() SchemaType
func (StringType) ParseString ¶ added in v0.1.0
func (_ StringType) ParseString(to, from string, isNew bool, mkErr ErrorRender) (string, error)
func (StringType) ParseStrings ¶ added in v0.1.21
func (_ StringType) ParseStrings(to, from string, isNew bool, mkErr ErrorRender) (string, error)
func (StringType) Render ¶ added in v0.0.11
func (s StringType) Render() (string, error)
func (StringType) RenderFormat ¶ added in v0.0.11
func (_ StringType) RenderFormat(from string) (string, error)
func (StringType) RenderFormatStrings ¶ added in v0.1.21
func (s StringType) RenderFormatStrings(to, from string, isNew bool) (string, error)
type StructureField ¶ added in v0.0.11
type StructureField struct {
Comment string
Name string
Type Render
Tags []StructureFieldTag
JSONTag string
}
func (StructureField) GetTag ¶ added in v0.1.0
func (sf StructureField) GetTag(k string) (zero StructureFieldTag, _ bool)
func (StructureField) Render ¶ added in v0.1.0
func (s StructureField) Render() (string, error)
type StructureFieldTag ¶ added in v0.0.11
type StructureType ¶ added in v0.0.11
type StructureType struct {
SingleValue
Fields []StructureField
AdditionalProperties *SchemaType
}
func (StructureType) Base ¶ added in v0.1.23
func (s StructureType) Base() SchemaType
func (StructureType) ParseString ¶ added in v0.1.0
func (s StructureType) ParseString(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
func (StructureType) ParseStrings ¶ added in v0.1.21
func (s StructureType) ParseStrings(to string, from string, isNew bool, mkErr ErrorRender) (string, error)
func (StructureType) Render ¶ added in v0.0.11
func (s StructureType) Render() (string, error)
func (StructureType) RenderFormat ¶ added in v0.1.0
func (s StructureType) RenderFormat(from string) (string, error)
func (StructureType) RenderFormatStrings ¶ added in v0.1.21
func (s StructureType) RenderFormatStrings(to, from string, isNew bool) (string, error)
Click to show internal directories.
Click to hide internal directories.