fuego

package module

Go to main page

Versions in this module

v0

v0.1.19

Oct 10, 2024

v0.1.18

Oct 6, 2024

v0.1.17

Oct 6, 2024

v0.1.16

Oct 5, 2024

Changes in this version

type HTTPError

+ func (HTTPError) OpenApiName() string

v0.1.15

Oct 5, 2024

Changes in this version

+ type OpenAPINamer interface

+ OpenApiName func() string

v0.1.14

Sep 21, 2024

Changes in this version

type Route

+ func (r Route[ResponseBody, RequestBody]) RequestDescription(desc string) Route[ResponseBody, RequestBody]

v0.1.13

Sep 21, 2024

v0.1.12

Sep 21, 2024

Changes in this version

type OpenAPIParam

+ Type ParamType

v0.1.11

Sep 21, 2024

Changes in this version

+ func WithExample(example string) func(opt *OpenAPIParamOption)

+ func WithRequiredParam() func(opt *OpenAPIParamOption)

+ func WithSchema(schema *openapi3.Schema) func(opt *OpenAPIParamOption)

type OpenAPIParamOption

+ Schema *openapi3.Schema

type Route

+ func (r Route[ResponseBody, RequestBody]) Query(name, description string, opts ...func(*OpenAPIParamOption)) Route[ResponseBody, RequestBody]

v0.1.10

Sep 20, 2024

v0.1.9

Sep 20, 2024

Changes in this version

+ func WithDescription(desc string) func(opt *GroupOption)

+ func WithName(name string) func(opt *GroupOption)

+ func WithTag(tag openapi3.Tag) func(opt *GroupOption)

+ func WithoutTag() func(opt *GroupOption)

v0.1.8

Sep 20, 2024

v0.1.7

Sep 20, 2024

v0.1.6

Sep 20, 2024

Changes in this version

+ const GinContextKey

type ContextNoBody

+ func (c ContextNoBody) GinContext() *gin.Context

v0.1.5

Sep 18, 2024

v0.1.4

Sep 18, 2024

v0.1.3

Sep 18, 2024

v0.1.2

Sep 18, 2024

v0.1.1

Sep 18, 2024

v0.1.0

Sep 18, 2024

Changes in this version

+ const JWTCookieName

+ 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

+ var SendError = func(w http.ResponseWriter, r *http.Request, err error)

+ var SendHTML = func(w http.ResponseWriter, r *http.Request, ans any) error

+ var SendJSON = func(w http.ResponseWriter, _ *http.Request, ans any) error

+ var SendXML = func(w http.ResponseWriter, _ *http.Request, ans any) error

+ var SendYAML = func(w http.ResponseWriter, _ *http.Request, ans any) error

+ 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 DefaultOpenAPIHandler(specURL string) http.Handler

+ func ErrorHandler(err error) error

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

+ func HTTPHandler[ReturnType, Body any, Contextable ctx[Body]](s *Server, controller func(c Contextable) (ReturnType, error)) http.HandlerFunc

+ func InferAcceptHeaderFromType(ans any) string

+ func NewOpenApiSpec() openapi3.T

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

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

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

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

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

+ func RegisterOpenAPIOperation[T, B any](group *RouterGroup, route Route[T, B]) (*openapi3.Operation, error)

+ func Send(w http.ResponseWriter, r *http.Request, ans any) (err error)

+ func SendHTMLError(w http.ResponseWriter, _ *http.Request, err error)

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

+ func SendText(w http.ResponseWriter, _ *http.Request, ans any) error

+ func SendTextError(w http.ResponseWriter, _ *http.Request, err error)

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

+ func SendYAMLError(w http.ResponseWriter, _ *http.Request, 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 *RouterGroup, middlewares ...func(http.Handler) http.Handler)

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

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

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

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

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

+ func WithErrorSerializer(serializer ErrorSender) func(*Server)

+ func WithGlobalResponseTypes(code int, description string, errorType ...any) func(*Server)

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

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

+ func WithSerializer(serializer Sender) func(*Server)

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

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

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

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

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

+ func WithXML() func(*Server)

+ func WithoutAutoGroupTags() func(*Server)

+ func WithoutLogger() func(*Server)

+ func WithoutStartupMessages() func(*Server)

+ type AutoAuthConfig struct

+ Enabled bool

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

+ type BadRequestError HTTPError

+ func (e BadRequestError) Error() string

+ 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 struct

+ Req *http.Request

+ Res http.ResponseWriter

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

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

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

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

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

+ func (c ContextNoBody) Err() error

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

+ 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) QueryParam(name string) string

+ func (c ContextNoBody) QueryParamArr(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() url.Values

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

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

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

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

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

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

+ func (c ContextNoBody) SetStatus(code int)

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

+ type ContextWithBody struct

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

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

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

+ type CtxRenderer interface

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

+ type DataOrTemplate struct

+ Data T

+ Template any

+ func DataOrHTML[T any](data T, template any) *DataOrTemplate[T]

+ func (m DataOrTemplate[T]) MarshalJSON() ([]byte, error)

+ func (m DataOrTemplate[T]) MarshalXML(e *xml.Encoder, _ xml.StartElement) error

+ func (m DataOrTemplate[T]) MarshalYAML() (interface{}, error)

+ func (m DataOrTemplate[T]) Render(c context.Context, w io.Writer) error

+ func (m DataOrTemplate[T]) String() string

+ type ErrorItem struct

+ More map[string]any

+ Name string

+ Reason string

+ type ErrorSender = func(http.ResponseWriter, *http.Request, error)

+ type ErrorWithStatus interface

+ StatusCode func() int

+ type ForbiddenError HTTPError

+ func (e ForbiddenError) Error() string

+ func (e ForbiddenError) StatusCode() int

+ func (e ForbiddenError) Unwrap() error

+ type Gomponent = Renderer

+ type GroupOption struct

+ HideTag bool

+ Tag openapi3.Tag

+ type H map[string]any

+ type HTML string

+ type HTTPError struct

+ Detail string

+ Err error

+ Errors []ErrorItem

+ Instance string

+ Status int

+ Title string

+ Type string

+ func (e HTTPError) Error() string

+ func (e HTTPError) StatusCode() int

+ func (e HTTPError) Unwrap() error

+ type InTransformer interface

+ InTransform func(context.Context) error

+ type LoginPayload struct

+ Password string

+ User string

+ 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

+ DisableSwaggerUI bool

+ JsonFilePath string

+ JsonUrl string

+ PrettyFormatJson bool

+ SwaggerUrl string

+ UIHandler func(specURL string) http.Handler

+ type OpenAPIDescriptioner interface

+ Description func() string

+ type OpenAPIParam struct

+ Description string

+ Name string

+ type OpenAPIParamOption struct

+ Example string

+ Required bool

+ Type ParamType

+ type OutTransformer interface

+ OutTransform func(context.Context) error

+ type ParamType string

+ const CookieParamType

+ const HeaderParamType

+ const QueryParamType

+ 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 Renderer interface

+ Render func(io.Writer) error

+ type Route struct

+ All bool

+ Handler http.Handler

+ Method string

+ Operation *openapi3.Operation

+ Path string

+ func AllStd(s *RouterGroup, path string, ...) Route[any, any]

+ func All[T, B any, Contexted ctx[B]](s *RouterGroup, path string, controller func(Contexted) (T, error), ...) Route[T, B]

+ func DeleteStd(s *RouterGroup, path string, ...) Route[any, any]

+ func Delete[T, B any, Contexted ctx[B]](s *RouterGroup, path string, controller func(Contexted) (T, error), ...) Route[T, B]

+ func GetStd(s *RouterGroup, path string, ...) Route[any, any]

+ func Get[T, B any, Contexted ctx[B]](s *RouterGroup, path string, controller func(Contexted) (T, error), ...) Route[T, B]

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

+ func PatchStd(s *RouterGroup, path string, ...) Route[any, any]

+ func Patch[T, B any, Contexted ctx[B]](s *RouterGroup, path string, controller func(Contexted) (T, error), ...) Route[T, B]

+ func PostStd(s *RouterGroup, path string, ...) Route[any, any]

+ func Post[T, B any, Contexted ctx[B]](s *RouterGroup, path string, controller func(Contexted) (T, error), ...) Route[T, B]

+ func PutStd(s *RouterGroup, path string, ...) Route[any, any]

+ func Put[T, B any, Contexted ctx[B]](s *RouterGroup, path string, controller func(Contexted) (T, error), ...) Route[T, B]

+ func Register[T, B any](group *RouterGroup, route Route[T, B], controller http.Handler, ...) Route[T, B]

+ func (r Route[ResponseBody, RequestBody]) AddError(code int, description string, errorType ...any) Route[ResponseBody, RequestBody]

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

+ func (r Route[ResponseBody, RequestBody]) Cookie(name, description string, params ...OpenAPIParamOption) 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 ...OpenAPIParamOption) Route[ResponseBody, RequestBody]

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

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

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

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

+ func (r Route[ResponseBody, RequestBody]) RequestContentType(consumes ...string) 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]

+ type RouterGroup struct

+ DisableOpenapi bool

+ func Group(group *RouterGroup, path string, groupOption ...GroupOption) *RouterGroup

+ func (group *RouterGroup) Group(path string, groupOption ...GroupOption) *RouterGroup

+ func (group *RouterGroup) Use(middlewares ...func(http.Handler) http.Handler)

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

+ func (s *RouterGroup) Cookie(name, description string, params ...OpenAPIParamOption) *RouterGroup

+ func (s *RouterGroup) Header(name, description string, params ...OpenAPIParamOption) *RouterGroup

+ func (s *RouterGroup) Hide() *RouterGroup

+ func (s *RouterGroup) Param(name, description string, params ...OpenAPIParamOption) *RouterGroup

+ func (s *RouterGroup) Query(name, description string, params ...OpenAPIParamOption) *RouterGroup

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

+ func (s *RouterGroup) Show() *RouterGroup

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

+ 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) LoginHandler(verifyUserInfo func(user, password string) (jwt.Claims, error)) func(*ContextWithBody[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 Sender func(http.ResponseWriter, *http.Request, any) error

+ type Server struct

+ DisallowUnknownFields bool

+ ErrorHandler func(err error) error

+ OpenApiSpec openapi3.T

+ Security Security

+ Serialize Sender

+ SerializeError ErrorSender

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

+ func NewServerWithRouterGroup(rg *gin.RouterGroup, options ...func(*Server)) *Server

+ func (s *Server) MarshalSpec(prettyFormatJSON bool) ([]byte, error)

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

+ func (s *Server) RouterGroup() *RouterGroup

+ func (s *Server) Run(addr string) error

+ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type StdRenderer struct

+ func (s StdRenderer) Render(ctx context.Context, w io.Writer) error

+ type Templ = CtxRenderer

+ type Timing struct

+ Desc string

+ Dur time.Duration

+ Name string

+ func (t Timing) String() string

+ type UnauthorizedError HTTPError

+ func (e UnauthorizedError) Error() string

+ func (e UnauthorizedError) StatusCode() int

+ func (e UnauthorizedError) Unwrap() error

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