echopen

package module

Go to main page

Versions in this module

v2

v2.0.2

Apr 3, 2026

Changes in this version

type RouteConfigFunc

+ func WithRequestBodySchemaDescription(mime string, description string, s *v320.Schema) RouteConfigFunc

v2.0.1

Mar 24, 2026

Changes in this version

type RouteConfigFunc

+ func WithRequestUpload(metadataProperty string, description string, metadata any) RouteConfigFunc

v2.0.0

Mar 5, 2026

Changes in this version

+ var ErrContentTypeNotSupported = fmt.Errorf("echopen: request did not match defined content types")

+ var ErrRequiredParameterMissing = fmt.Errorf("echopen: required parameter missing")

+ var ErrSecurityRequirementsNotMet = fmt.Errorf("echopen: at least one required security scheme must be provided")

+ func DefaultErrorHandler(err error, c echo.Context)

+ func ExtractJSONTags(field reflect.StructField) (string, bool)

+ func ExtractValidationRules(field reflect.StructField, schema *v320.Schema)

+ func PtrTo[T any](v T) *T

+ type APIWrapper struct

+ Config *Config

+ Engine *echo.Echo

+ Spec *v320.Specification

+ func New(title string, apiVersion string, config ...WrapperConfigFunc) *APIWrapper

+ func (a *APIWrapper) SetBaseURL(baseURL string)

+ func (a *APIWrapper) SetErrorHandler(h echo.HTTPErrorHandler)

+ func (a *APIWrapper) SetSpecContact(c *v320.Contact)

+ func (a *APIWrapper) SetSpecDescription(desc string)

+ func (a *APIWrapper) SetSpecExternalDocs(d *v320.ExternalDocs)

+ func (a *APIWrapper) SetSpecLicense(l *v320.License)

+ func (a *APIWrapper) SetTermsOfService(tos string)

+ func (w *APIWrapper) Add(method string, path string, handler echo.HandlerFunc, ...) *RouteWrapper

+ func (w *APIWrapper) DELETE(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (w *APIWrapper) GET(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (w *APIWrapper) Group(prefix string, config ...GroupConfigFunc) *GroupWrapper

+ func (w *APIWrapper) HEAD(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (w *APIWrapper) OPTIONS(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (w *APIWrapper) PATCH(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (w *APIWrapper) POST(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (w *APIWrapper) PUT(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (w *APIWrapper) ServeJSONSpec(path string, filters ...SpecFilterFunc) *echo.Route

+ func (w *APIWrapper) ServeRapidoc(path string, schemaPath string) *echo.Route

+ func (w *APIWrapper) ServeSwaggerUI(path string, schemaPath string, version string, baseUrlFormat string) *echo.Route

+ func (w *APIWrapper) ServeYAMLSpec(path string, filters ...SpecFilterFunc) *echo.Route

+ func (w *APIWrapper) Start(addr string) error

+ func (w *APIWrapper) StructFieldToSchemaRef(f reflect.StructField) *v320.Ref[v320.Schema]

+ func (w *APIWrapper) StructTypeToSchema(target reflect.Type, nameTag string) *v320.Schema

+ func (w *APIWrapper) TRACE(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (w *APIWrapper) ToSchemaRef(target interface{}) *v320.Ref[v320.Schema]

+ func (w *APIWrapper) TypeToSchema(typ reflect.Type) *v320.Schema

+ func (w *APIWrapper) TypeToSchemaRef(typ reflect.Type) *v320.Ref[v320.Schema]

+ func (w *APIWrapper) TypesToSchemaRef(types ...reflect.Type) *v320.Ref[v320.Schema]

+ func (w *APIWrapper) WriteYAMLSpec(path string) error

+ type Config struct

+ BaseURL string

+ DisableDefaultMiddleware bool

+ type CookieParameterConfig struct

+ Description string

+ Name string

+ Required bool

+ Schema *v320.Schema

+ type GroupConfigFunc func(*GroupWrapper) *GroupWrapper

+ func WithGroupMiddlewares(m ...echo.MiddlewareFunc) GroupConfigFunc

+ func WithGroupSecurityRequirement(req *v320.SecurityRequirement) GroupConfigFunc

+ func WithGroupTags(tags ...string) GroupConfigFunc

+ type GroupWrapper struct

+ API *APIWrapper

+ GroupWrapper *GroupWrapper

+ Middlewares []echo.MiddlewareFunc

+ Prefix string

+ RouterGroup *echo.Group

+ SecurityRequirements []*v320.SecurityRequirement

+ Tags []string

+ func (g *GroupWrapper) Add(method string, path string, handler echo.HandlerFunc, ...) *RouteWrapper

+ func (g *GroupWrapper) DELETE(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (g *GroupWrapper) GET(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (g *GroupWrapper) Group(prefix string, config ...GroupConfigFunc) *GroupWrapper

+ func (g *GroupWrapper) HEAD(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (g *GroupWrapper) OPTIONS(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (g *GroupWrapper) PATCH(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (g *GroupWrapper) POST(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (g *GroupWrapper) PUT(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ func (g *GroupWrapper) TRACE(path string, handler echo.HandlerFunc, config ...RouteConfigFunc) *RouteWrapper

+ type HeaderParameterConfig struct

+ AllowMultiple bool

+ Description string

+ Examples []*v320.Example

+ Explode bool

+ Name string

+ Required bool

+ Schema *v320.Schema

+ Style string

+ type PathParameterConfig struct

+ Description string

+ Examples []*v320.Example

+ Name string

+ Schema *v320.Schema

+ type ResponseStructConfig struct

+ Description string

+ JSON bool

+ Target interface{}

+ type RouteConfigFunc func(*RouteWrapper) *RouteWrapper

+ func WithCookieParameter(name string, description string, example interface{}) RouteConfigFunc

+ func WithCookieParameterConfig(c *CookieParameterConfig) RouteConfigFunc

+ func WithDeprecated() RouteConfigFunc

+ func WithDescription(desc string) RouteConfigFunc

+ func WithFormStruct(target interface{}) RouteConfigFunc

+ func WithHeaderParameter(name string, description string, example interface{}) RouteConfigFunc

+ func WithHeaderParameterConfig(c *HeaderParameterConfig) RouteConfigFunc

+ func WithMiddlewares(m ...echo.MiddlewareFunc) RouteConfigFunc

+ func WithOperationID(id string) RouteConfigFunc

+ func WithOptionalSecurity() RouteConfigFunc

+ func WithParameter(param *v320.Parameter) RouteConfigFunc

+ func WithPathParameter(name string, description string, example interface{}) RouteConfigFunc

+ func WithPathParameterConfig(c *PathParameterConfig) RouteConfigFunc

+ func WithQueryStruct(target interface{}) RouteConfigFunc

+ func WithRequestBody(rb *v320.RequestBody) RouteConfigFunc

+ func WithRequestBodyRef(name string) RouteConfigFunc

+ func WithRequestBodySchema(mime string, s *v320.Schema) RouteConfigFunc

+ func WithRequestBodyStruct(mime string, description string, target interface{}) RouteConfigFunc

+ func WithResponse(code string, resp *v320.Response) RouteConfigFunc

+ func WithResponseDescription(code string, description string) RouteConfigFunc

+ func WithResponseFile(code string, description string, mime string) RouteConfigFunc

+ func WithResponseRef(code string, name string) RouteConfigFunc

+ func WithResponseStruct(code string, description string, target interface{}) RouteConfigFunc

+ func WithResponseStructConfig(code string, config *ResponseStructConfig) RouteConfigFunc

+ func WithResponseType(code string, description string, example interface{}) RouteConfigFunc

+ func WithSecurityRequirement(name string, scopes []string) RouteConfigFunc

+ func WithSummary(sum string) RouteConfigFunc

+ func WithTags(tags ...string) RouteConfigFunc

+ type RouteWrapper struct

+ API *APIWrapper

+ FormSchema *v320.Schema

+ Group *GroupWrapper

+ Handler echo.HandlerFunc

+ Middlewares []echo.MiddlewareFunc

+ Operation *v320.Operation

+ PathItem *v320.PathItem

+ QuerySchema *v320.Schema

+ RequestBodySchema map[string]*v320.Schema

+ Route *echo.Route

+ type SpecFilterFunc = func(s *v320.Specification) *v320.Specification

+ func ExcludeTags(tags ...string) SpecFilterFunc

+ func IncludeTags(tags ...string) SpecFilterFunc

+ type WrapperConfigFunc func(*APIWrapper) *APIWrapper

+ func WithBaseURL(baseURL string) WrapperConfigFunc

+ func WithSpecContact(c *v320.Contact) WrapperConfigFunc

+ func WithSpecDescription(desc string) WrapperConfigFunc

+ func WithSpecExternalDocs(d *v320.ExternalDocs) WrapperConfigFunc

+ func WithSpecLicense(l *v320.License) WrapperConfigFunc

+ func WithSpecServer(s *v320.Server) WrapperConfigFunc

+ func WithSpecTag(t *v320.Tag) WrapperConfigFunc

+ func WithSpecTermsOfService(tos string) WrapperConfigFunc

Other modules containing this package

github.com/anteo/echopen

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