schema

Documentation

Index

• func PathFromOpenApiPath(path string) string
• func RequestSchemaFromOpenApi3RequestRef(ref *openapi3.RequestBody, mediaType string) any
• func ResponseSchemaFromOpenApi3ResponseRef(ref *openapi3.ResponseRef, mediaType string) any
• func SchemaFromAny(config any) any
• type Mapper
• type MapperImpl
  • func NewMapper() *MapperImpl
  • func (*MapperImpl) MapToRequestParameters(ctx echo.Context) RequestParameters
• type ParameterProperties
• type ParameterProperty
• type RequestParameterProperty
• type RequestParameters
• type RequestSchema
• type Route
  • func (r Route) Match(path string) (map[string]string, bool)
• type RouteProperty
• type SchemaInfo

Functions

func PathFromOpenApiPath

func PathFromOpenApiPath(path string) string

func RequestSchemaFromOpenApi3RequestRef

func RequestSchemaFromOpenApi3RequestRef(
	ref *openapi3.RequestBody,
	mediaType string,
) any

func ResponseSchemaFromOpenApi3ResponseRef

func ResponseSchemaFromOpenApi3ResponseRef(
	ref *openapi3.ResponseRef,
	mediaType string,
) any

func SchemaFromAny

func SchemaFromAny(config any) any

Types

type Mapper

type Mapper interface {
	MapToRequestParameters(ctx echo.Context) RequestParameters
}

type MapperImpl

type MapperImpl struct{}

func NewMapper

func NewMapper() *MapperImpl

func (*MapperImpl) MapToRequestParameters

func (*MapperImpl) MapToRequestParameters(ctx echo.Context) RequestParameters

Map implements Mapper.

type ParameterProperties

type ParameterProperties map[string]*ParameterProperty

type ParameterProperty

type ParameterProperty struct {
	Required bool
	Type     reflect.Type
}

type RequestParameterProperty

type RequestParameterProperty struct {
	PathParameterProperties  ParameterProperties
	QueryParameterProperties ParameterProperties
}

type RequestParameters

type RequestParameters struct {
	PathParams  map[string]string
	QueryParams url.Values
}

type RequestSchema

type RequestSchema struct {
	// contains filtered or unexported fields
}

type Route

type Route struct {
	Path   string
	Method string
}

func (Route) Match

func (r Route) Match(path string) (map[string]string, bool)

Match returns true if the given path matches the route.

type RouteProperty

type RouteProperty struct {
	RequestParameterProperty
	RequestSchema  dstruct.DynamicStructModifier
	ResponseSchema dstruct.DynamicStructModifier
}

type SchemaInfo

type SchemaInfo struct {
	Kind   reflect.Kind
	Tags   string
	Format string
}