github.com/gofiber/fiber/v2@v2.47.0/docs/api/constants.md (about)

     1  ---
     2  id: constants
     3  title: 📋 Constants
     4  description: Some constants for Fiber.
     5  sidebar_position: 4
     6  ---
     7  
     8  HTTP methods were copied from net/http.
     9  
    10  ```go
    11  const (
    12      MethodGet     = "GET"     // RFC 7231, 4.3.1
    13      MethodHead    = "HEAD"    // RFC 7231, 4.3.2
    14      MethodPost    = "POST"    // RFC 7231, 4.3.3
    15      MethodPut     = "PUT"     // RFC 7231, 4.3.4
    16      MethodPatch   = "PATCH"   // RFC 5789
    17      MethodDelete  = "DELETE"  // RFC 7231, 4.3.5
    18      MethodConnect = "CONNECT" // RFC 7231, 4.3.6
    19      MethodOptions = "OPTIONS" // RFC 7231, 4.3.7
    20      MethodTrace   = "TRACE"   // RFC 7231, 4.3.8
    21      methodUse     = "USE"
    22  )
    23  ```
    24  
    25  MIME types that are commonly used
    26  
    27  ```go
    28  const (
    29  	MIMETextXML               = "text/xml"
    30  	MIMETextHTML              = "text/html"
    31  	MIMETextPlain             = "text/plain"
    32  	MIMEApplicationXML        = "application/xml"
    33  	MIMEApplicationJSON       = "application/json"
    34  	MIMEApplicationJavaScript = "application/javascript"
    35  	MIMEApplicationForm       = "application/x-www-form-urlencoded"
    36  	MIMEOctetStream           = "application/octet-stream"
    37  	MIMEMultipartForm         = "multipart/form-data"
    38  
    39  	MIMETextXMLCharsetUTF8               = "text/xml; charset=utf-8"
    40  	MIMETextHTMLCharsetUTF8              = "text/html; charset=utf-8"
    41  	MIMETextPlainCharsetUTF8             = "text/plain; charset=utf-8"
    42  	MIMEApplicationXMLCharsetUTF8        = "application/xml; charset=utf-8"
    43  	MIMEApplicationJSONCharsetUTF8       = "application/json; charset=utf-8"
    44  	MIMEApplicationJavaScriptCharsetUTF8 = "application/javascript; charset=utf-8"
    45  )
    46  ```
    47  
    48  HTTP status codes were copied from net/http.
    49  
    50  ```go
    51  const (
    52  	StatusContinue                      = 100 // RFC 7231, 6.2.1
    53  	StatusSwitchingProtocols            = 101 // RFC 7231, 6.2.2
    54  	StatusProcessing                    = 102 // RFC 2518, 10.1
    55  	StatusEarlyHints                    = 103 // RFC 8297
    56  	StatusOK                            = 200 // RFC 7231, 6.3.1
    57  	StatusCreated                       = 201 // RFC 7231, 6.3.2
    58  	StatusAccepted                      = 202 // RFC 7231, 6.3.3
    59  	StatusNonAuthoritativeInformation   = 203 // RFC 7231, 6.3.4
    60  	StatusNoContent                     = 204 // RFC 7231, 6.3.5
    61  	StatusResetContent                  = 205 // RFC 7231, 6.3.6
    62  	StatusPartialContent                = 206 // RFC 7233, 4.1
    63  	StatusMultiStatus                   = 207 // RFC 4918, 11.1
    64  	StatusAlreadyReported               = 208 // RFC 5842, 7.1
    65  	StatusIMUsed                        = 226 // RFC 3229, 10.4.1
    66  	StatusMultipleChoices               = 300 // RFC 7231, 6.4.1
    67  	StatusMovedPermanently              = 301 // RFC 7231, 6.4.2
    68  	StatusFound                         = 302 // RFC 7231, 6.4.3
    69  	StatusSeeOther                      = 303 // RFC 7231, 6.4.4
    70  	StatusNotModified                   = 304 // RFC 7232, 4.1
    71  	StatusUseProxy                      = 305 // RFC 7231, 6.4.5
    72  	StatusTemporaryRedirect             = 307 // RFC 7231, 6.4.7
    73  	StatusPermanentRedirect             = 308 // RFC 7538, 3
    74  	StatusBadRequest                    = 400 // RFC 7231, 6.5.1
    75  	StatusUnauthorized                  = 401 // RFC 7235, 3.1
    76  	StatusPaymentRequired               = 402 // RFC 7231, 6.5.2
    77  	StatusForbidden                     = 403 // RFC 7231, 6.5.3
    78  	StatusNotFound                      = 404 // RFC 7231, 6.5.4
    79  	StatusMethodNotAllowed              = 405 // RFC 7231, 6.5.5
    80  	StatusNotAcceptable                 = 406 // RFC 7231, 6.5.6
    81  	StatusProxyAuthRequired             = 407 // RFC 7235, 3.2
    82  	StatusRequestTimeout                = 408 // RFC 7231, 6.5.7
    83  	StatusConflict                      = 409 // RFC 7231, 6.5.8
    84  	StatusGone                          = 410 // RFC 7231, 6.5.9
    85  	StatusLengthRequired                = 411 // RFC 7231, 6.5.10
    86  	StatusPreconditionFailed            = 412 // RFC 7232, 4.2
    87  	StatusRequestEntityTooLarge         = 413 // RFC 7231, 6.5.11
    88  	StatusRequestURITooLong             = 414 // RFC 7231, 6.5.12
    89  	StatusUnsupportedMediaType          = 415 // RFC 7231, 6.5.13
    90  	StatusRequestedRangeNotSatisfiable  = 416 // RFC 7233, 4.4
    91  	StatusExpectationFailed             = 417 // RFC 7231, 6.5.14
    92  	StatusTeapot                        = 418 // RFC 7168, 2.3.3
    93  	StatusMisdirectedRequest            = 421 // RFC 7540, 9.1.2
    94  	StatusUnprocessableEntity           = 422 // RFC 4918, 11.2
    95  	StatusLocked                        = 423 // RFC 4918, 11.3
    96  	StatusFailedDependency              = 424 // RFC 4918, 11.4
    97  	StatusTooEarly                      = 425 // RFC 8470, 5.2.
    98  	StatusUpgradeRequired               = 426 // RFC 7231, 6.5.15
    99  	StatusPreconditionRequired          = 428 // RFC 6585, 3
   100  	StatusTooManyRequests               = 429 // RFC 6585, 4
   101  	StatusRequestHeaderFieldsTooLarge   = 431 // RFC 6585, 5
   102  	StatusUnavailableForLegalReasons    = 451 // RFC 7725, 3
   103  	StatusInternalServerError           = 500 // RFC 7231, 6.6.1
   104  	StatusNotImplemented                = 501 // RFC 7231, 6.6.2
   105  	StatusBadGateway                    = 502 // RFC 7231, 6.6.3
   106  	StatusServiceUnavailable            = 503 // RFC 7231, 6.6.4
   107  	StatusGatewayTimeout                = 504 // RFC 7231, 6.6.5
   108  	StatusHTTPVersionNotSupported       = 505 // RFC 7231, 6.6.6
   109  	StatusVariantAlsoNegotiates         = 506 // RFC 2295, 8.1
   110  	StatusInsufficientStorage           = 507 // RFC 4918, 11.5
   111  	StatusLoopDetected                  = 508 // RFC 5842, 7.2
   112  	StatusNotExtended                   = 510 // RFC 2774, 7
   113  	StatusNetworkAuthenticationRequired = 511 // RFC 6585, 6
   114  )
   115  ```
   116  
   117  Errors
   118  
   119  ```go
   120  var (
   121  	ErrBadRequest                    = NewError(StatusBadRequest)                    // RFC 7231, 6.5.1
   122  	ErrUnauthorized                  = NewError(StatusUnauthorized)                  // RFC 7235, 3.1
   123  	ErrPaymentRequired               = NewError(StatusPaymentRequired)               // RFC 7231, 6.5.2
   124  	ErrForbidden                     = NewError(StatusForbidden)                     // RFC 7231, 6.5.3
   125  	ErrNotFound                      = NewError(StatusNotFound)                      // RFC 7231, 6.5.4
   126  	ErrMethodNotAllowed              = NewError(StatusMethodNotAllowed)              // RFC 7231, 6.5.5
   127  	ErrNotAcceptable                 = NewError(StatusNotAcceptable)                 // RFC 7231, 6.5.6
   128  	ErrProxyAuthRequired             = NewError(StatusProxyAuthRequired)             // RFC 7235, 3.2
   129  	ErrRequestTimeout                = NewError(StatusRequestTimeout)                // RFC 7231, 6.5.7
   130  	ErrConflict                      = NewError(StatusConflict)                      // RFC 7231, 6.5.8
   131  	ErrGone                          = NewError(StatusGone)                          // RFC 7231, 6.5.9
   132  	ErrLengthRequired                = NewError(StatusLengthRequired)                // RFC 7231, 6.5.10
   133  	ErrPreconditionFailed            = NewError(StatusPreconditionFailed)            // RFC 7232, 4.2
   134  	ErrRequestEntityTooLarge         = NewError(StatusRequestEntityTooLarge)         // RFC 7231, 6.5.11
   135  	ErrRequestURITooLong             = NewError(StatusRequestURITooLong)             // RFC 7231, 6.5.12
   136  	ErrUnsupportedMediaType          = NewError(StatusUnsupportedMediaType)          // RFC 7231, 6.5.13
   137  	ErrRequestedRangeNotSatisfiable  = NewError(StatusRequestedRangeNotSatisfiable)  // RFC 7233, 4.4
   138  	ErrExpectationFailed             = NewError(StatusExpectationFailed)             // RFC 7231, 6.5.14
   139  	ErrTeapot                        = NewError(StatusTeapot)                        // RFC 7168, 2.3.3
   140  	ErrMisdirectedRequest            = NewError(StatusMisdirectedRequest)            // RFC 7540, 9.1.2
   141  	ErrUnprocessableEntity           = NewError(StatusUnprocessableEntity)           // RFC 4918, 11.2
   142  	ErrLocked                        = NewError(StatusLocked)                        // RFC 4918, 11.3
   143  	ErrFailedDependency              = NewError(StatusFailedDependency)              // RFC 4918, 11.4
   144  	ErrTooEarly                      = NewError(StatusTooEarly)                      // RFC 8470, 5.2.
   145  	ErrUpgradeRequired               = NewError(StatusUpgradeRequired)               // RFC 7231, 6.5.15
   146  	ErrPreconditionRequired          = NewError(StatusPreconditionRequired)          // RFC 6585, 3
   147  	ErrTooManyRequests               = NewError(StatusTooManyRequests)               // RFC 6585, 4
   148  	ErrRequestHeaderFieldsTooLarge   = NewError(StatusRequestHeaderFieldsTooLarge)   // RFC 6585, 5
   149  	ErrUnavailableForLegalReasons    = NewError(StatusUnavailableForLegalReasons)    // RFC 7725, 3
   150  	ErrInternalServerError           = NewError(StatusInternalServerError)           // RFC 7231, 6.6.1
   151  	ErrNotImplemented                = NewError(StatusNotImplemented)                // RFC 7231, 6.6.2
   152  	ErrBadGateway                    = NewError(StatusBadGateway)                    // RFC 7231, 6.6.3
   153  	ErrServiceUnavailable            = NewError(StatusServiceUnavailable)            // RFC 7231, 6.6.4
   154  	ErrGatewayTimeout                = NewError(StatusGatewayTimeout)                // RFC 7231, 6.6.5
   155  	ErrHTTPVersionNotSupported       = NewError(StatusHTTPVersionNotSupported)       // RFC 7231, 6.6.6
   156  	ErrVariantAlsoNegotiates         = NewError(StatusVariantAlsoNegotiates)         // RFC 2295, 8.1
   157  	ErrInsufficientStorage           = NewError(StatusInsufficientStorage)           // RFC 4918, 11.5
   158  	ErrLoopDetected                  = NewError(StatusLoopDetected)                  // RFC 5842, 7.2
   159  	ErrNotExtended                   = NewError(StatusNotExtended)                   // RFC 2774, 7
   160  	ErrNetworkAuthenticationRequired = NewError(StatusNetworkAuthenticationRequired) // RFC 6585, 6
   161  )
   162  ```
   163  
   164  HTTP Headers were copied from net/http.
   165  
   166  ```go
   167  const (
   168  	HeaderAuthorization                   = "Authorization"
   169  	HeaderProxyAuthenticate               = "Proxy-Authenticate"
   170  	HeaderProxyAuthorization              = "Proxy-Authorization"
   171  	HeaderWWWAuthenticate                 = "WWW-Authenticate"
   172  	HeaderAge                             = "Age"
   173  	HeaderCacheControl                    = "Cache-Control"
   174  	HeaderClearSiteData                   = "Clear-Site-Data"
   175  	HeaderExpires                         = "Expires"
   176  	HeaderPragma                          = "Pragma"
   177  	HeaderWarning                         = "Warning"
   178  	HeaderAcceptCH                        = "Accept-CH"
   179  	HeaderAcceptCHLifetime                = "Accept-CH-Lifetime"
   180  	HeaderContentDPR                      = "Content-DPR"
   181  	HeaderDPR                             = "DPR"
   182  	HeaderEarlyData                       = "Early-Data"
   183  	HeaderSaveData                        = "Save-Data"
   184  	HeaderViewportWidth                   = "Viewport-Width"
   185  	HeaderWidth                           = "Width"
   186  	HeaderETag                            = "ETag"
   187  	HeaderIfMatch                         = "If-Match"
   188  	HeaderIfModifiedSince                 = "If-Modified-Since"
   189  	HeaderIfNoneMatch                     = "If-None-Match"
   190  	HeaderIfUnmodifiedSince               = "If-Unmodified-Since"
   191  	HeaderLastModified                    = "Last-Modified"
   192  	HeaderVary                            = "Vary"
   193  	HeaderConnection                      = "Connection"
   194  	HeaderKeepAlive                       = "Keep-Alive"
   195  	HeaderAccept                          = "Accept"
   196  	HeaderAcceptCharset                   = "Accept-Charset"
   197  	HeaderAcceptEncoding                  = "Accept-Encoding"
   198  	HeaderAcceptLanguage                  = "Accept-Language"
   199  	HeaderCookie                          = "Cookie"
   200  	HeaderExpect                          = "Expect"
   201  	HeaderMaxForwards                     = "Max-Forwards"
   202  	HeaderSetCookie                       = "Set-Cookie"
   203  	HeaderAccessControlAllowCredentials   = "Access-Control-Allow-Credentials"
   204  	HeaderAccessControlAllowHeaders       = "Access-Control-Allow-Headers"
   205  	HeaderAccessControlAllowMethods       = "Access-Control-Allow-Methods"
   206  	HeaderAccessControlAllowOrigin        = "Access-Control-Allow-Origin"
   207  	HeaderAccessControlExposeHeaders      = "Access-Control-Expose-Headers"
   208  	HeaderAccessControlMaxAge             = "Access-Control-Max-Age"
   209  	HeaderAccessControlRequestHeaders     = "Access-Control-Request-Headers"
   210  	HeaderAccessControlRequestMethod      = "Access-Control-Request-Method"
   211  	HeaderOrigin                          = "Origin"
   212  	HeaderTimingAllowOrigin               = "Timing-Allow-Origin"
   213  	HeaderXPermittedCrossDomainPolicies   = "X-Permitted-Cross-Domain-Policies"
   214  	HeaderDNT                             = "DNT"
   215  	HeaderTk                              = "Tk"
   216  	HeaderContentDisposition              = "Content-Disposition"
   217  	HeaderContentEncoding                 = "Content-Encoding"
   218  	HeaderContentLanguage                 = "Content-Language"
   219  	HeaderContentLength                   = "Content-Length"
   220  	HeaderContentLocation                 = "Content-Location"
   221  	HeaderContentType                     = "Content-Type"
   222  	HeaderForwarded                       = "Forwarded"
   223  	HeaderVia                             = "Via"
   224  	HeaderXForwardedFor                   = "X-Forwarded-For"
   225  	HeaderXForwardedHost                  = "X-Forwarded-Host"
   226  	HeaderXForwardedProto                 = "X-Forwarded-Proto"
   227  	HeaderXForwardedProtocol              = "X-Forwarded-Protocol"
   228  	HeaderXForwardedSsl                   = "X-Forwarded-Ssl"
   229  	HeaderXUrlScheme                      = "X-Url-Scheme"
   230  	HeaderLocation                        = "Location"
   231  	HeaderFrom                            = "From"
   232  	HeaderHost                            = "Host"
   233  	HeaderReferer                         = "Referer"
   234  	HeaderReferrerPolicy                  = "Referrer-Policy"
   235  	HeaderUserAgent                       = "User-Agent"
   236  	HeaderAllow                           = "Allow"
   237  	HeaderServer                          = "Server"
   238  	HeaderAcceptRanges                    = "Accept-Ranges"
   239  	HeaderContentRange                    = "Content-Range"
   240  	HeaderIfRange                         = "If-Range"
   241  	HeaderRange                           = "Range"
   242  	HeaderContentSecurityPolicy           = "Content-Security-Policy"
   243  	HeaderContentSecurityPolicyReportOnly = "Content-Security-Policy-Report-Only"
   244  	HeaderCrossOriginResourcePolicy       = "Cross-Origin-Resource-Policy"
   245  	HeaderExpectCT                        = "Expect-CT"
   246  	HeaderFeaturePolicy                   = "Feature-Policy"
   247  	HeaderPublicKeyPins                   = "Public-Key-Pins"
   248  	HeaderPublicKeyPinsReportOnly         = "Public-Key-Pins-Report-Only"
   249  	HeaderStrictTransportSecurity         = "Strict-Transport-Security"
   250  	HeaderUpgradeInsecureRequests         = "Upgrade-Insecure-Requests"
   251  	HeaderXContentTypeOptions             = "X-Content-Type-Options"
   252  	HeaderXDownloadOptions                = "X-Download-Options"
   253  	HeaderXFrameOptions                   = "X-Frame-Options"
   254  	HeaderXPoweredBy                      = "X-Powered-By"
   255  	HeaderXXSSProtection                  = "X-XSS-Protection"
   256  	HeaderLastEventID                     = "Last-Event-ID"
   257  	HeaderNEL                             = "NEL"
   258  	HeaderPingFrom                        = "Ping-From"
   259  	HeaderPingTo                          = "Ping-To"
   260  	HeaderReportTo                        = "Report-To"
   261  	HeaderTE                              = "TE"
   262  	HeaderTrailer                         = "Trailer"
   263  	HeaderTransferEncoding                = "Transfer-Encoding"
   264  	HeaderSecWebSocketAccept              = "Sec-WebSocket-Accept"
   265  	HeaderSecWebSocketExtensions          = "Sec-WebSocket-Extensions"
   266  	HeaderSecWebSocketKey                 = "Sec-WebSocket-Key"
   267  	HeaderSecWebSocketProtocol            = "Sec-WebSocket-Protocol"
   268  	HeaderSecWebSocketVersion             = "Sec-WebSocket-Version"
   269  	HeaderAcceptPatch                     = "Accept-Patch"
   270  	HeaderAcceptPushPolicy                = "Accept-Push-Policy"
   271  	HeaderAcceptSignature                 = "Accept-Signature"
   272  	HeaderAltSvc                          = "Alt-Svc"
   273  	HeaderDate                            = "Date"
   274  	HeaderIndex                           = "Index"
   275  	HeaderLargeAllocation                 = "Large-Allocation"
   276  	HeaderLink                            = "Link"
   277  	HeaderPushPolicy                      = "Push-Policy"
   278  	HeaderRetryAfter                      = "Retry-After"
   279  	HeaderServerTiming                    = "Server-Timing"
   280  	HeaderSignature                       = "Signature"
   281  	HeaderSignedHeaders                   = "Signed-Headers"
   282  	HeaderSourceMap                       = "SourceMap"
   283  	HeaderUpgrade                         = "Upgrade"
   284  	HeaderXDNSPrefetchControl             = "X-DNS-Prefetch-Control"
   285  	HeaderXPingback                       = "X-Pingback"
   286  	HeaderXRequestID                      = "X-Request-ID"
   287  	HeaderXRequestedWith                  = "X-Requested-With"
   288  	HeaderXRobotsTag                      = "X-Robots-Tag"
   289  	HeaderXUACompatible                   = "X-UA-Compatible"
   290  )
   291  ```