fuego

package module

Go to main page

Versions in this module

v0

v0.13.4

Mar 28, 2024

Changes in this version

type OpenAPIConfig

+ PrettyFormatJson bool

v0.13.3

Mar 27, 2024

Changes in this version

type ContextNoBody

+ func (c ContextNoBody) Deadline() (deadline time.Time, ok bool)

+ func (c ContextNoBody) Done() <-chan struct{}

+ func (c ContextNoBody) Err() error

+ func (c ContextNoBody) Value(key any) any

v0.13.2

Mar 26, 2024

Changes in this version

+ func ReadXML[B any](context context.Context, input io.Reader) (B, error)

v0.13.1

Mar 21, 2024

v0.13.0

Mar 21, 2024

Changes in this version

+ func DefaultOpenAPIHandler(specURL string) http.Handler

+ func ReadYAML[B any](context context.Context, input io.Reader) (B, error)

+ func WithAddr(addr string) func(*Server)

+ func WithCorsMiddleware(corsMiddleware func(http.Handler) http.Handler) func(*Server)

+ func WithOpenAPIConfig(openapiConfig OpenAPIConfig) func(*Server)

+ func WithValidator(newValidator *validator.Validate) func(*Server)

type BadRequestError

+ func (e BadRequestError) StatusCode() int

+ func (e BadRequestError) Unwrap() error

+ type ConflictError HTTPError

+ func (e ConflictError) Error() string

+ func (e ConflictError) StatusCode() int

+ func (e ConflictError) Unwrap() error

type ContextNoBody

+ func (c ContextNoBody) Cookie(name string) (*http.Cookie, error)

+ func (c ContextNoBody) Header(key string) string

+ func (c ContextNoBody) SetCookie(cookie http.Cookie)

+ func (c ContextNoBody) SetHeader(key, value string)

+ type ErrorItem struct

+ More map[string]any

+ Name string

+ Reason string

type ErrorWithStatus

+ StatusCode func() int

+ type ForbiddenError HTTPError

+ func (e ForbiddenError) Error() string

+ func (e ForbiddenError) StatusCode() int

+ func (e ForbiddenError) Unwrap() error

type HTTPError

+ Detail string

+ Errors []ErrorItem

+ Instance string

+ Title string

+ Type string

+ func (e HTTPError) Unwrap() error

+ type NotFoundError HTTPError

+ func (e NotFoundError) Error() string

+ func (e NotFoundError) StatusCode() int

+ func (e NotFoundError) Unwrap() error

+ type OpenAPIConfig struct

+ DisableLocalSave bool

+ DisableSwagger bool

+ JsonFilePath string

+ JsonUrl string

+ SwaggerUrl string

+ UIHandler func(specURL string) http.Handler

type Server

+ DisableOpenapi bool

+ OpenAPIConfig OpenAPIConfig

+ func (s *Server) AddTags(tags ...string) *Server

+ func (s *Server) Hide() *Server

+ func (s *Server) OutputOpenAPISpec() openapi3.T

+ func (s *Server) RemoveTags(tags ...string) *Server

+ func (s *Server) Show() *Server

+ func (s *Server) Tags(tags ...string) *Server

+ type UnauthorizedError HTTPError

+ func (e UnauthorizedError) Error() string

+ func (e UnauthorizedError) StatusCode() int

+ func (e UnauthorizedError) Unwrap() error

v0.12.0

Feb 26, 2024

v0.11.1

Feb 26, 2024

v0.11.0

Feb 22, 2024

Changes in this version

type ContextNoBody

+ Req *http.Request

+ Res http.ResponseWriter

+ type OpenAPIParam struct

+ Example string

+ Required bool

+ Type string

type OpenapiConfig

+ JsonFilePath string

+ JsonUrl string

type Route

+ func (r Route[ResponseBody, RequestBody]) Cookie(name, description string, params ...OpenAPIParam) Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) Deprecated() Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) Description(description string) Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) Header(name, description string, params ...OpenAPIParam) Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) OperationID(operationID string) Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) Param(paramType, name, description string, params ...OpenAPIParam) Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) QueryParam(name, description string, params ...OpenAPIParam) Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) Summary(summary string) Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) Tags(tags ...string) Route[ResponseBody, RequestBody]

v0.10.4

Feb 8, 2024

v0.10.3

Feb 8, 2024

v0.10.2

Feb 8, 2024

v0.10.1

Feb 8, 2024

v0.10.0

Feb 7, 2024

Changes in this version

+ func WithLogHandler(handler slog.Handler) func(*Server)

+ func WithValue(ctx context.Context, val any) context.Context

+ type ContextNoBody struct

+ func (c ContextNoBody) Body() (any, error)

+ func (c ContextNoBody) Context() context.Context

+ func (c ContextNoBody) MainLang() string

+ func (c ContextNoBody) MainLocale() string

+ func (c ContextNoBody) MustBody() any

+ func (c ContextNoBody) PathParam(name string) string

+ func (c ContextNoBody) PathParams() map[string]string

+ func (c ContextNoBody) QueryParam(name string) string

+ func (c ContextNoBody) QueryParamBool(name string, defaultValue bool) bool

+ func (c ContextNoBody) QueryParamBoolErr(name string) (bool, error)

+ func (c ContextNoBody) QueryParamInt(name string, defaultValue int) int

+ func (c ContextNoBody) QueryParamIntErr(name string) (int, error)

+ func (c ContextNoBody) QueryParams() map[string]string

+ func (c ContextNoBody) Redirect(code int, url string) (any, error)

+ func (c ContextNoBody) Render(templateToExecute string, data any, layoutsGlobs ...string) (HTML, error)

+ func (c ContextNoBody) Request() *http.Request

+ func (c ContextNoBody) Response() http.ResponseWriter

+ func (c ContextNoBody) SetStatus(code int)

+ type ContextWithBody struct

+ func (c *ContextWithBody[B]) Body() (B, error)

+ func (c *ContextWithBody[B]) MustBody() B

type Route

+ func (r Route[ResponseBody, RequestBody]) RemoveTags(tags ...string) Route[ResponseBody, RequestBody]

+ type Timing struct

+ Desc string

+ Dur time.Duration

+ Name string

+ func (t Timing) String() string

v0.9.0

Dec 21, 2023

Changes in this version

type ClassicContext

+ func (c ClassicContext) MainLang() string

+ func (c ClassicContext) MainLocale() string

type Ctx

+ MainLang func() string

+ MainLocale func() string

+ type CtxRenderer interface

+ Render func(context.Context, io.Writer) error

+ type Gomponent = Renderer

+ type Renderer interface

+ Render func(io.Writer) error

+ type Templ = CtxRenderer

v0.8.0

Dec 18, 2023

Changes in this version

+ const JWTCookieName

+ const JWTInfoCtxKey

+ const MethodAll

+ var ErrExpired = errors.New("token is expired")

+ var ErrInvalidRolesType = errors.New("invalid role type. Must be []string")

+ var ErrInvalidTokenType = errors.New("invalid token type")

+ var ErrTokenNotFound = errors.New("token not found")

+ var ErrUnauthorized = errors.New("unauthorized")

+ var ReadOptions = readOptions

+ func AuthWall(authorizedRoles ...string) func(next http.Handler) http.Handler

+ func AuthWallRegex(acceptedRolesRegex string) func(next http.Handler) http.Handler

+ func AuthWallRegexp(acceptedRolesRegex *regexp.Regexp) func(next http.Handler) http.Handler

+ func ErrorHandler(err error) error

+ func GetToken[T any](ctx context.Context) (T, error)

+ func Markdown(content string) template.HTML

+ func NewOpenApiSpec() openapi3.T

+ func ReadJSON[B any](input io.Reader) (B, error)

+ func ReadString[B ~string](input io.Reader) (B, error)

+ func ReadURLEncoded[B any](r *http.Request) (B, error)

+ func RegisterOpenAPIOperation[T any, B any](s *Server, method, path string) (*openapi3.Operation, error)

+ func Send(w http.ResponseWriter, text string)

+ func SendJSON(w http.ResponseWriter, ans any)

+ func SendJSONError(w http.ResponseWriter, err error)

+ func SendXML(w http.ResponseWriter, ans any)

+ func SendXMLError(w http.ResponseWriter, err error)

+ func TokenFromContext(ctx context.Context) (jwt.Claims, error)

+ func TokenFromCookie(r *http.Request) string

+ func TokenFromHeader(r *http.Request) string

+ func TokenFromQueryParam(r *http.Request) string

+ func Use(s *Server, middlewares ...func(http.Handler) http.Handler)

+ func UseStd(s *Server, middlewares ...func(http.Handler) http.Handler)

+ func WithAutoAuth(verifyUserInfo func(user, password string) (jwt.Claims, error)) func(*Server)

+ func WithBasePath(basePath string) func(*Server)

+ func WithDisallowUnknownFields(b bool) func(*Server)

+ func WithErrorHandler(errorHandler func(err error) error) func(*Server)

+ func WithErrorSerializer(serializer func(w http.ResponseWriter, err error)) func(*Server)

+ func WithHandler(handler slog.Handler) func(*Server)

+ func WithMaxBodySize(maxBodySize int64) func(*Server)

+ func WithOpenapiConfig(openapiConfig OpenapiConfig) func(*Server)

+ func WithPort(port string) func(*Server)

+ func WithSerializer(serializer func(w http.ResponseWriter, ans any)) func(*Server)

+ func WithTemplateFS(fs fs.FS) func(*Server)

+ func WithTemplateGlobs(patterns ...string) func(*Server)

+ func WithTemplates(templates *template.Template) func(*Server)

+ func WithXML() func(*Server)

+ func WithoutLogger() func(*Server)

+ type AutoAuthConfig struct

+ Enabled bool

+ VerifyUserInfo func(user, password string) (jwt.Claims, error)

+ type BadRequestError struct

+ Err error

+ Message string

+ MoreInfo map[string]any

+ func (e BadRequestError) Error() string

+ func (e BadRequestError) Info() map[string]any

+ func (e BadRequestError) Status() int

+ type ClassicContext struct

+ func (c ClassicContext) Body() (any, error)

+ func (c ClassicContext) Context() context.Context

+ func (c ClassicContext) MustBody() any

+ func (c ClassicContext) Pass() ClassicContext

+ func (c ClassicContext) PathParam(name string) string

+ func (c ClassicContext) PathParams() map[string]string

+ func (c ClassicContext) QueryParam(name string) string

+ func (c ClassicContext) QueryParamBool(name string, defaultValue bool) bool

+ func (c ClassicContext) QueryParamBoolErr(name string) (bool, error)

+ func (c ClassicContext) QueryParamInt(name string, defaultValue int) int

+ func (c ClassicContext) QueryParamIntErr(name string) (int, error)

+ func (c ClassicContext) QueryParams() map[string]string

+ func (c ClassicContext) Redirect(code int, url string) (any, error)

+ func (c ClassicContext) Render(templateToExecute string, data any, layoutsGlobs ...string) (HTML, error)

+ func (c ClassicContext) Request() *http.Request

+ func (c ClassicContext) Response() http.ResponseWriter

+ type Context struct

+ func NewContext[B any](w http.ResponseWriter, r *http.Request, options readOptions) *Context[B]

+ func (c *Context[B]) Body() (B, error)

+ func (c *Context[B]) MustBody() B

+ func (c *Context[B]) Pass() ClassicContext

+ func (c *Context[B]) SafeShallowCopy() *Context[B]

+ type Controller func(c Context[Body]) (ReturnType, error)

+ type Ctx interface

+ Body func() (B, error)

+ Context func() context.Context

+ MustBody func() B

+ Pass func() ClassicContext

+ PathParam func(name string) string

+ PathParams func() map[string]string

+ QueryParam func(name string) string

+ QueryParamBool func(name string, defaultValue bool) bool

+ QueryParamBoolErr func(name string) (bool, error)

+ QueryParamInt func(name string, defaultValue int) int

+ QueryParamIntErr func(name string) (int, error)

+ QueryParams func() map[string]string

+ Redirect func(code int, url string) (any, error)

+ Render func(templateToExecute string, data any, templateGlobsToOverride ...string) (HTML, error)

+ Request func() *http.Request

+ Response func() http.ResponseWriter

+ type ErrorWithInfo interface

+ Info func() map[string]any

+ type ErrorWithStatus interface

+ Status func() int

+ type H map[string]any

+ type HTML string

+ type HTTPError struct

+ Err error

+ Message string

+ MoreInfo map[string]any

+ StatusCode int

+ func (e HTTPError) Error() string

+ func (e HTTPError) Info() map[string]any

+ func (e HTTPError) Status() int

+ type InTransformer interface

+ InTransform func() error

+ type LoginPayload struct

+ Password string

+ User string

+ type OpenapiConfig struct

+ DisableLocalSave bool

+ DisableSwagger bool

+ JsonSpecLocalPath string

+ JsonSpecUrl string

+ SwaggerUrl string

+ type OutTransformer interface

+ OutTransform func(context.Context) error

+ type QueryParamInvalidTypeError struct

+ Err error

+ ExpectedType string

+ ParamName string

+ ParamValue string

+ func (e QueryParamInvalidTypeError) Error() string

+ type QueryParamNotFoundError struct

+ ParamName string

+ func (e QueryParamNotFoundError) Error() string

+ type Route struct

+ func All[T any, B any](s *Server, path string, controller func(Ctx[B]) (T, error), ...) Route[T, B]

+ func DeleteStd(s *Server, path string, controller func(http.ResponseWriter, *http.Request), ...) Route[any, any]

+ func Delete[T any, B any](s *Server, path string, controller func(Ctx[B]) (T, error), ...) Route[T, B]

+ func GetStd(s *Server, path string, controller func(http.ResponseWriter, *http.Request), ...) Route[any, any]

+ func Get[T any, B any](s *Server, path string, controller func(Ctx[B]) (T, error), ...) Route[T, B]

+ func Handle(s *Server, path string, controller http.Handler, ...) Route[any, any]

+ func PatchStd(s *Server, path string, controller func(http.ResponseWriter, *http.Request), ...) Route[any, any]

+ func Patch[T any, B any](s *Server, path string, controller func(Ctx[B]) (T, error), ...) Route[T, B]

+ func PostStd(s *Server, path string, controller func(http.ResponseWriter, *http.Request), ...) Route[any, any]

+ func Post[T any, B any](s *Server, path string, controller func(Ctx[B]) (T, error), ...) Route[T, B]

+ func PutStd(s *Server, path string, controller func(http.ResponseWriter, *http.Request), ...) Route[any, any]

+ func Put[T any, B any](s *Server, path string, controller func(Ctx[B]) (T, error), ...) Route[T, B]

+ func RegisterStd(s *Server, method string, path string, ...) Route[any, any]

+ func Register[T any, B any](s *Server, method string, path string, controller func(Ctx[B]) (T, error), ...) Route[T, B]

+ func (r Route[ResponseBody, RequestBody]) AddTags(tags ...string) Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) SetDeprecated() Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) SetTags(tags ...string) Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) WithDescription(description string) Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) WithQueryParam(name, description string) Route[ResponseBody, RequestBody]

+ func (r Route[ResponseBody, RequestBody]) WithSummary(summary string) Route[ResponseBody, RequestBody]

+ type Security struct

+ ExpiresInterval time.Duration

+ Now func() time.Time

+ func NewSecurity() Security

+ func (security Security) CookieLogoutHandler(w http.ResponseWriter, r *http.Request)

+ func (security Security) GenerateToken(claims jwt.Claims) (token string, err error)

+ func (security Security) GenerateTokenToCookies(claims jwt.Claims, w http.ResponseWriter) (string, error)

+ func (security Security) GetTokenInfo(token string) (jwt.Claims, error)

+ func (security Security) LoginHandler(verifyUserInfo func(user, password string) (jwt.Claims, error)) func(Ctx[LoginPayload]) (tokenResponse, error)

+ func (security Security) RefreshHandler(w http.ResponseWriter, r *http.Request)

+ func (security Security) StdLoginHandler(verifyUserInfo func(r *http.Request) (jwt.Claims, error)) func(w http.ResponseWriter, r *http.Request)

+ func (security Security) TokenToContext(searchFunc ...func(*http.Request) string) func(next http.Handler) http.Handler

+ func (security Security) ValidateToken(token string) (*jwt.Token, error)

+ type Server struct

+ DisallowUnknownFields bool

+ ErrorHandler func(err error) error

+ Mux *http.ServeMux

+ OpenApiSpec openapi3.T

+ OpenapiConfig OpenapiConfig

+ Security Security

+ Serialize func(w http.ResponseWriter, ans any)

+ SerializeError func(w http.ResponseWriter, err error)

+ Server *http.Server

+ func Group(s *Server, path string) *Server

+ func NewServer(options ...func(*Server)) *Server

+ func (s *Server) Run()

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