lite

package module

Go to main page

Versions in this module

v0

v0.1.23

Sep 4, 2024

v0.1.22

Aug 26, 2024

v0.1.21

Aug 26, 2024

Changes in this version

+ var DefaultErrorContentTypeResponses = []string

+ var DefaultErrorResponses = map[int]HTTPError

+ type BadRequestError HTTPError

+ func (e BadRequestError) Error() string

+ func (e BadRequestError) StatusCode() int

type Config

+ func SetLogger(logger *slog.Logger) Config

+ func SetValidator(v *validator.Validate) Config

+ type ConflictError HTTPError

+ func (e ConflictError) Error() string

+ func (e ConflictError) StatusCode() int

+ type ContentType string

+ const ContentType3GP

+ const ContentType7Z

+ const ContentTypeASX

+ const ContentTypeATOM

+ const ContentTypeAVI

+ const ContentTypeAVIF

+ const ContentTypeBMP

+ const ContentTypeCCO

+ const ContentTypeCRT

+ const ContentTypeCSS

+ const ContentTypeDOC

+ const ContentTypeDOCX

+ const ContentTypeEOT

+ const ContentTypeFLV

+ const ContentTypeFormData

+ const ContentTypeGIF

+ const ContentTypeHQX

+ const ContentTypeHTC

+ const ContentTypeHTML

+ const ContentTypeICO

+ const ContentTypeJAD

+ const ContentTypeJAR

+ const ContentTypeJARDIFF

+ const ContentTypeJNG

+ const ContentTypeJNLP

+ const ContentTypeJPEG

+ const ContentTypeJS

+ const ContentTypeJSON

+ const ContentTypeKML

+ const ContentTypeKMZ

+ const ContentTypeM3U8

+ const ContentTypeM4A

+ const ContentTypeM4V

+ const ContentTypeMIDI

+ const ContentTypeMML

+ const ContentTypeMNG

+ const ContentTypeMOV

+ const ContentTypeMP3

+ const ContentTypeMP4

+ const ContentTypeMPEG

+ const ContentTypeODG

+ const ContentTypeODP

+ const ContentTypeODS

+ const ContentTypeODT

+ const ContentTypeOGG

+ const ContentTypeOctetStream

+ const ContentTypePDF

+ const ContentTypePL

+ const ContentTypePNG

+ const ContentTypePPT

+ const ContentTypePPTX

+ const ContentTypePRC

+ const ContentTypePS

+ const ContentTypeRA

+ const ContentTypeRAR

+ const ContentTypeRPM

+ const ContentTypeRSS

+ const ContentTypeRTF

+ const ContentTypeRUN

+ const ContentTypeSEA

+ const ContentTypeSIT

+ const ContentTypeSVG

+ const ContentTypeSWF

+ const ContentTypeTCL

+ const ContentTypeTIFF

+ const ContentTypeTS

+ const ContentTypeTXT

+ const ContentTypeWASM

+ const ContentTypeWBMP

+ const ContentTypeWEBM

+ const ContentTypeWEBP

+ const ContentTypeWML

+ const ContentTypeWMLC

+ const ContentTypeWMV

+ const ContentTypeWOFF

+ const ContentTypeWOFF2

+ const ContentTypeXFormData

+ const ContentTypeXHTML

+ const ContentTypeXLS

+ const ContentTypeXLSX

+ const ContentTypeXML

+ const ContentTypeXPI

+ const ContentTypeXSPF

+ const ContentTypeZIP

+ type Error interface

+ StatusCode func() int

+ type ForbiddenError HTTPError

+ func (e ForbiddenError) Error() string

+ func (e ForbiddenError) StatusCode() int

+ type HTTPError struct

+ Context string

+ Description string

+ Status int

+ Title string

+ Type string

+ Violations []Violation

+ func NewBadRequestError(descriptions ...string) HTTPError

+ func NewConflictError(descriptions ...string) HTTPError

+ func NewError(status int, descriptions ...string) HTTPError

+ func NewErrorResponse(status int, context, title, errorType string, description string, ...) HTTPError

+ func NewForbiddenError(descriptions ...string) HTTPError

+ func NewInternalServerError(descriptions ...string) HTTPError

+ func NewNotFoundError(descriptions ...string) HTTPError

+ func NewServiceUnavailableError(descriptions ...string) HTTPError

+ func NewUnauthorizedError(descriptions ...string) HTTPError

+ func (e HTTPError) Descriptions() string

+ func (e HTTPError) Error() string

+ func (e HTTPError) StatusCode() int

+ type InternalServerError HTTPError

+ func (e InternalServerError) Error() string

+ func (e InternalServerError) StatusCode() int

+ type NotFoundError HTTPError

+ func (e NotFoundError) Error() string

+ func (e NotFoundError) StatusCode() int

+ type ServiceUnavailableError HTTPError

+ func (e ServiceUnavailableError) Error() string

+ func (e ServiceUnavailableError) StatusCode() int

+ type UnauthorizedError HTTPError

+ func (e UnauthorizedError) Error() string

+ func (e UnauthorizedError) StatusCode() int

+ type Violation struct

+ Code string

+ Message string

+ More map[string]any

+ PropertyPath string

v0.1.20

Aug 5, 2024

v0.1.19

Aug 5, 2024

v0.1.18

Aug 4, 2024

v0.1.17

Jul 27, 2024

v0.1.16

Jul 27, 2024

Changes in this version

type Config

+ func AddServer(url, description string) Config

+ func AddTags(tags ...*openapi3.Tag) Config

+ func SetContact(contact *openapi3.Contact) Config

+ func SetDescription(description string) Config

+ func SetLicense(license *openapi3.License) Config

+ func SetTermsOfService(termsOfService string) Config

+ func SetTitle(title string) Config

+ func SetVersion(version string) Config

type Route

+ func (r Route[ResponseBody, Request]) AddErrorResponse(statusCode int, contentType ...string) Route[ResponseBody, Request]

v0.1.15

Jul 25, 2024

v0.1.14

Jul 24, 2024

v0.1.13

Jul 24, 2024

v0.1.12

Jul 21, 2024

v0.1.11

Jul 21, 2024

v0.1.1

Jul 21, 2024

v0.1.0

Jul 21, 2024

Changes in this version

type App

+ func (s *App) Run() error

+ type Config func(s *App)

+ func SetAddress(address string) Config

+ func SetDisableLocalSave(disable bool) Config

+ func SetDisableSwagger(disable bool) Config

+ func SetOpenAPIPath(path string) Config

+ func SetSwaggerURL(url string) Config

+ func SetTypeOfExtension(extension TypeOfExtension) Config

+ func SetUIHandler(handler func(specURL string) fiber.Handler) Config

+ type List struct

+ Items []T

+ Length int

+ func NewList[T any](items []T) List[T]

+ type TypeOfExtension string

+ const JSONExtension

+ const YAMLExtension

v0.0.93

Jul 14, 2024

v0.0.92

Jul 12, 2024

Changes in this version

type Context

+ Get func(key string) string

type ContextNoRequest

+ func (c *ContextNoRequest) Get(key string) string

v0.0.91

Jul 7, 2024

v0.0.9

Jul 7, 2024

v0.0.8

Jul 6, 2024

Changes in this version

+ const HeaderAccept

+ const HeaderAcceptCH

+ const HeaderAcceptCHLifetime

+ const HeaderAcceptCharset

+ const HeaderAcceptEncoding

+ const HeaderAcceptLanguage

+ const HeaderAcceptPatch

+ const HeaderAcceptPushPolicy

+ const HeaderAcceptRanges

+ const HeaderAcceptSignature

+ const HeaderAccessControlAllowCredentials

+ const HeaderAccessControlAllowHeaders

+ const HeaderAccessControlAllowMethods

+ const HeaderAccessControlAllowOrigin

+ const HeaderAccessControlExposeHeaders

+ const HeaderAccessControlMaxAge

+ const HeaderAccessControlRequestHeaders

+ const HeaderAccessControlRequestMethod

+ const HeaderAge

+ const HeaderAllow

+ const HeaderAltSvc

+ const HeaderAuthorization

+ const HeaderCacheControl

+ const HeaderClearSiteData

+ const HeaderConnection

+ const HeaderContentDPR

+ const HeaderContentDisposition

+ const HeaderContentEncoding

+ const HeaderContentLanguage

+ const HeaderContentLength

+ const HeaderContentLocation

+ const HeaderContentRange

+ const HeaderContentSecurityPolicy

+ const HeaderContentSecurityPolicyReportOnly

+ const HeaderContentType

+ const HeaderCookie

+ const HeaderCrossOriginResourcePolicy

+ const HeaderDNT

+ const HeaderDPR

+ const HeaderDate

+ const HeaderETag

+ const HeaderEarlyData

+ const HeaderExpect

+ const HeaderExpectCT

+ const HeaderExpires

+ const HeaderFeaturePolicy

+ const HeaderForwarded

+ const HeaderFrom

+ const HeaderHost

+ const HeaderIfMatch

+ const HeaderIfModifiedSince

+ const HeaderIfNoneMatch

+ const HeaderIfRange

+ const HeaderIfUnmodifiedSince

+ const HeaderIndex

+ const HeaderKeepAlive

+ const HeaderLargeAllocation

+ const HeaderLastEventID

+ const HeaderLastModified

+ const HeaderLink

+ const HeaderLocation

+ const HeaderMaxForwards

+ const HeaderNEL

+ const HeaderOrigin

+ const HeaderPingFrom

+ const HeaderPingTo

+ const HeaderPragma

+ const HeaderProxyAuthenticate

+ const HeaderProxyAuthorization

+ const HeaderProxyConnection

+ const HeaderPublicKeyPins

+ const HeaderPublicKeyPinsReportOnly

+ const HeaderPushPolicy

+ const HeaderRange

+ const HeaderReferer

+ const HeaderReferrerPolicy

+ const HeaderReportTo

+ const HeaderRetryAfter

+ const HeaderSaveData

+ const HeaderSecWebSocketAccept

+ const HeaderSecWebSocketExtensions

+ const HeaderSecWebSocketKey

+ const HeaderSecWebSocketProtocol

+ const HeaderSecWebSocketVersion

+ const HeaderServer

+ const HeaderServerTiming

+ const HeaderSetCookie

+ const HeaderSignature

+ const HeaderSignedHeaders

+ const HeaderSourceMap

+ const HeaderStrictTransportSecurity

+ const HeaderTE

+ const HeaderTimingAllowOrigin

+ const HeaderTk

+ const HeaderTrailer

+ const HeaderTransferEncoding

+ const HeaderUpgrade

+ const HeaderUpgradeInsecureRequests

+ const HeaderUserAgent

+ const HeaderVary

+ const HeaderVia

+ const HeaderViewportWidth

+ const HeaderWWWAuthenticate

+ const HeaderWarning

+ const HeaderWidth

+ const HeaderXContentTypeOptions

+ const HeaderXDNSPrefetchControl

+ const HeaderXDownloadOptions

+ const HeaderXForwardedFor

+ const HeaderXForwardedHost

+ const HeaderXForwardedProto

+ const HeaderXFrameOptions

+ const HeaderXPermittedCrossDomainPolicies

+ const HeaderXPingback

+ const HeaderXPoweredBy

+ const HeaderXRequestedWith

+ const HeaderXRobotsTag

+ const HeaderXUACompatible

+ const HeaderXXSSProtection

+ const StatusAccepted

+ const StatusAlreadyReported

+ const StatusBadGateway

+ const StatusBadRequest

+ const StatusConflict

+ const StatusContinue

+ const StatusCreated

+ const StatusEarlyHints

+ const StatusExpectationFailed

+ const StatusFailedDependency

+ const StatusForbidden

+ const StatusFound

+ const StatusGatewayTimeout

+ const StatusGone

+ const StatusHTTPVersionNotSupported

+ const StatusIMUsed

+ const StatusInsufficientStorage

+ const StatusInternalServerError

+ const StatusLengthRequired

+ const StatusLocked

+ const StatusLoopDetected

+ const StatusMethodNotAllowed

+ const StatusMisdirectedRequest

+ const StatusMovedPermanently

+ const StatusMultiStatus

+ const StatusMultipleChoices

+ const StatusNetworkAuthenticationRequired

+ const StatusNoContent

+ const StatusNonAuthoritativeInfo

+ const StatusNotAcceptable

+ const StatusNotExtended

+ const StatusNotFound

+ const StatusNotImplemented

+ const StatusNotModified

+ const StatusOK

+ const StatusPartialContent

+ const StatusPaymentRequired

+ const StatusPermanentRedirect

+ const StatusPreconditionFailed

+ const StatusPreconditionRequired

+ const StatusProcessing

+ const StatusProxyAuthRequired

+ const StatusRequestEntityTooLarge

+ const StatusRequestHeaderFieldsTooLarge

+ const StatusRequestTimeout

+ const StatusRequestURITooLong

+ const StatusRequestedRangeNotSatisfiable

+ const StatusResetContent

+ const StatusSeeOther

+ const StatusServiceUnavailable

+ const StatusSwitchingProtocols

+ const StatusTeapot

+ const StatusTemporaryRedirect

+ const StatusTooManyRequests

+ const StatusUnauthorized

+ const StatusUnavailableForLegalReasons

+ const StatusUnprocessableEntity

+ const StatusUnsupportedMediaType

+ const StatusUpgradeRequired

+ const StatusUseProxy

+ const StatusVariantAlsoNegotiates

+ func NewOpenAPISpec() openapi3.T

+ func StatusMessage(statusCode int) string

+ func Use(app *App, args ...any)

+ type App struct

+ OpenAPIConfig OpenAPIConfig

+ OpenAPISpec openapi3.T

+ Serializer func(ctx *fasthttp.RequestCtx, response any) error

+ func Group(app *App, path string) *App

+ func New() *App

+ func (s *App) AddServer(url, description string)

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

+ func (s *App) Description(description string) *App

+ func (s *App) Listen(address string) error

+ func (s *App) SaveOpenAPISpec() ([]byte, error)

+ func (s *App) Shutdown() error

+ func (s *App) Title(title string) *App

+ func (s *App) Version(version string) *App

+ type Context interface

+ Accepts func(offers ...string) string

+ AcceptsCharsets func(offers ...string) string

+ AcceptsEncodings func(offers ...string) string

+ AcceptsLanguages func(offers ...string) string

+ App func() *App

+ Append func(field string, values ...string)

+ Attachment func(filename ...string)

+ BaseURL func() string

+ BodyRaw func() []byte

+ ClearCookie func(key ...string)

+ Context func() context.Context

+ Cookie func(cookie *fiber.Cookie)

+ Cookies func(key string, defaultValue ...string) string

+ Download func(file string, filename ...string) error

+ Format func(body interface{}) error

+ Hostname func() string

+ IP func() string

+ IPs func() []string

+ Is func(extension string) bool

+ Links func(link ...string)

+ Method func(override ...string) string

+ OriginalURL func() string

+ Port func() string

+ Request func() *fasthttp.Request

+ RequestContext func() *fasthttp.RequestCtx

+ Requests func() (Request, error)

+ Response func() *fasthttp.Response

+ SaveFile func(fileheader *multipart.FileHeader, path string) error

+ Set func(key string, val string)

+ SetContentType func(extension string, charset ...string) Context[Request]

+ SetUserContext func(ctx context.Context)

+ Status func(status int) Context[Request]

+ type ContextNoRequest struct

+ func (c *ContextNoRequest) Accepts(offers ...string) string

+ func (c *ContextNoRequest) AcceptsCharsets(offers ...string) string

+ func (c *ContextNoRequest) AcceptsEncodings(offers ...string) string

+ func (c *ContextNoRequest) AcceptsLanguages(offers ...string) string

+ func (c *ContextNoRequest) App() *App

+ func (c *ContextNoRequest) Append(field string, values ...string)

+ func (c *ContextNoRequest) Attachment(filename ...string)

+ func (c *ContextNoRequest) BaseURL() string

+ func (c *ContextNoRequest) BodyRaw() []byte

+ func (c *ContextNoRequest) ClearCookie(key ...string)

+ func (c *ContextNoRequest) Context() context.Context

+ func (c *ContextNoRequest) Cookie(cookie *fiber.Cookie)

+ func (c *ContextNoRequest) Cookies(key string, defaultValue ...string) string

+ func (c *ContextNoRequest) Download(file string, filename ...string) error

+ func (c *ContextNoRequest) Format(body interface{}) error

+ func (c *ContextNoRequest) Hostname() string

+ func (c *ContextNoRequest) IP() string

+ func (c *ContextNoRequest) IPs() []string

+ func (c *ContextNoRequest) Is(extension string) bool

+ func (c *ContextNoRequest) Links(link ...string)

+ func (c *ContextNoRequest) Method(override ...string) string

+ func (c *ContextNoRequest) OriginalURL() string

+ func (c *ContextNoRequest) Port() string

+ func (c *ContextNoRequest) Request() *fasthttp.Request

+ func (c *ContextNoRequest) RequestContext() *fasthttp.RequestCtx

+ func (c *ContextNoRequest) Requests() (any, error)

+ func (c *ContextNoRequest) Response() *fasthttp.Response

+ func (c *ContextNoRequest) SaveFile(file *multipart.FileHeader, path string) error

+ func (c *ContextNoRequest) Set(key string, val string)

+ func (c *ContextNoRequest) SetContentType(extension string, charset ...string) Context[any]

+ func (c *ContextNoRequest) SetUserContext(ctx context.Context)

+ func (c *ContextNoRequest) Status(status int) Context[any]

+ type ContextWithRequest struct

+ func (c *ContextWithRequest[Request]) Requests() (Request, error)

+ func (c *ContextWithRequest[Request]) SetContentType(extension string, charset ...string) Context[Request]

+ func (c *ContextWithRequest[Request]) Status(status int) Context[Request]

+ type OpenAPIConfig struct

+ DisableLocalSave bool

+ DisableSwagger bool

+ SwaggerURL string

+ UIHandler func(specURL string) fiber.Handler

+ YamlURL string

+ type Route struct

+ func Connect[ResponseBody, Request any, Contexter Context[Request]](app *App, path string, controller func(Contexter) (ResponseBody, error), ...) Route[ResponseBody, Request]

+ func Delete[ResponseBody, Request any, Contexter Context[Request]](app *App, path string, controller func(Contexter) (ResponseBody, error), ...) Route[ResponseBody, Request]

+ func Get[ResponseBody, Request any, Contexter Context[Request]](app *App, path string, controller func(Contexter) (ResponseBody, error), ...) Route[ResponseBody, Request]

+ func Head[ResponseBody, Request any, Contexter Context[Request]](app *App, path string, controller func(Contexter) (ResponseBody, error), ...) Route[ResponseBody, Request]

+ func Options[ResponseBody, Request any, Contexter Context[Request]](app *App, path string, controller func(Contexter) (ResponseBody, error), ...) Route[ResponseBody, Request]

+ func Patch[ResponseBody, Request any, Contexter Context[Request]](app *App, path string, controller func(Contexter) (ResponseBody, error), ...) Route[ResponseBody, Request]

+ func Post[ResponseBody, Request any, Contexter Context[Request]](app *App, path string, controller func(Contexter) (ResponseBody, error), ...) Route[ResponseBody, Request]

+ func Put[ResponseBody, Request any, Contexter Context[Request]](app *App, path string, controller func(Contexter) (ResponseBody, error), ...) Route[ResponseBody, Request]

+ func Trace[ResponseBody, Request any, Contexter Context[Request]](app *App, path string, controller func(Contexter) (ResponseBody, error), ...) Route[ResponseBody, Request]

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

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

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

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

+ func (r Route[ResponseBody, Request]) SetResponseContentType(contentType string) Route[ResponseBody, Request]

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

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