api

func (Payload) Map ¶

func (p Payload) Map() map[string]interface{}

Map convert payload data to map

func (Response) Accepted ¶

func (r Response) Accepted(code string, payload Payload, header ...ResponseHeader)

Accepted generate a Response with status code 202.

The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place.

There is no facility in HTTP for re-sending a status code from an asynchronous operation.

The 202 Response is intentionally noncommittal. Its purpose is to allow a server to accept a request for some other process (perhaps a batch-oriented process that is only run once per day) without requiring that the user agent's connection to the server persist until the process is completed. The representation sent with this Response ought to describe the request's current status and point to (or embed) a status monitor that can provide the user with an estimate of when the request will be fulfilled.

func (Response) AlreadyReported ¶

func (r Response) AlreadyReported(code string, payload Payload, header ...ResponseHeader)

AlreadyReported generate a Response with status code 208.

Used inside a DAV: propstat Response element to avoid enumerating the internal members of multiple bindings to the same collection repeatedly.

For each binding to a collection inside the request's scope, only one will be reported with a 200 status, while subsequent DAV:Response elements for all other bindings will use the 208 status, and no DAV:Response elements for their descendants are included.

Note that the 208 status will only occur for "Depth: infinity" requests, and that it is of particular importance when the multiple collection bindings cause a bind loop.

A client can request the DAV:resource-id property in a PROPFIND request to guarantee that they can accurately reconstruct the binding structure of a collection with multiple bindings to a single resource.

For backward compatibility with clients not aware of the 208 status code appearing in multistatus Response bodies, it SHOULD NOT be used unless the client has signaled support for this specification using the "DAV" request header. Instead, a 508 Loop Detected status should be returned when a binding loop is discovered. This allows the server to return the 508 as the top-level return status, if it discovers it before it started the Response, or in the middle of a multistatus, if it discovers it in the middle of streaming out a multistatus Response.

func (Response) BadGateway ¶

func (r Response) BadGateway(code string, payload Payload, header ...ResponseHeader)

BadGateway generate a Response with status code 502.

The server, while acting as a gateway or proxy, received an invalid Response from an inbound server it accessed while attempting to fulfill the request.

func (Response) BadRequest ¶

func (r Response) BadRequest(code string, payload Payload, header ...ResponseHeader)

BadRequest generate a Response with status code 400.

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

func (Response) ClientClosedRequest ¶

func (r Response) ClientClosedRequest(code string, payload Payload, header ...ResponseHeader)

ClientClosedRequest generate a Response with status code 499.

A non-standard status code introduced by nginx for the case when a client closes the connection while nginx is processing the request.

func (Response) Conflict ¶

func (r Response) Conflict(code string, payload Payload, header ...ResponseHeader)

Conflict generate a Response with status code 409.

The request could not be completed due to a conflict with the current state of the target resource. This code is used in situations where the user might be able to resolve the conflict and resubmit the request.

The server SHOULD generate a payload that includes enough information for a user to recognize the source of the conflict.

Conflicts are most likely to occur in Response to a PUT request. For example, if versioning were being used and the representation being PUT included changes to a resource that conflict with those made by an earlier (third-party) request, the origin server might use a 409 Response to indicate that it can't complete the request. In this case, the Response representation would likely contain information useful for merging the differences based on the revision history.

func (Response) ConnectionClosedWithoutResponse ¶

func (r Response) ConnectionClosedWithoutResponse(code string, payload Payload, header ...ResponseHeader)

ConnectionClosedWithoutResponse generate a Response with status code 444.

A non-standard status code used to instruct nginx to close the connection without sending a Response to the client, most commonly used to deny malicious or malformed requests.

This status code is not seen by the client, it only appears in nginx log files.

func (Response) Continue ¶

func (r Response) Continue(code string, payload Payload, header ...ResponseHeader)

Continue generate a Response with status code 100.

The initial part of a request has been received and has not yet been rejected by the server. The server intends to send a final Response after the request has been fully received and acted upon.

When the request contains an Expect header field that includes a 100-continue expectation, the 100 Response indicates that the server wishes to receive the request payload body. The client ought to continue sending the request and discard the 100 Response.

If the request did not contain an Expect header field containing the 100-continue expectation, the client can simply discard this interim Response.

func (Response) Created ¶

func (r Response) Created(code string, payload Payload, header ...ResponseHeader)

Created generate a Response with status code 201.

The request has been fulfilled and has resulted in one or more new resources being created.

The primary resource created by the request is identified by either a Location header field in the Response or, if no Location field is received, by the effective request URI.

The 201 Response payload typically describes and links to the resource(s) created. See Section 7.2 of RFC7231 for a discussion of the meaning and purpose of validator header fields, such as ETag and Last-Modified, in a 201 Response.

func (Response) ExpectationFailed ¶

func (r Response) ExpectationFailed(code string, payload Payload, header ...ResponseHeader)

ExpectationFailed generate a Response with status code 417.

The expectation given in the request's Expect header field could not be met by at least one of the inbound servers.

func (Response) FailedDependency ¶

func (r Response) FailedDependency(code string, payload Payload, header ...ResponseHeader)

FailedDependency generate a Response with status code 424.

The method could not be performed on the resource because the requested action depended on another action and that action failed.

For example, if a command in a PROPPATCH method fails, then, at minimum, the rest of the commands will also fail with 424 Failed Dependency.

func (Response) Forbidden ¶

func (r Response) Forbidden(code string, payload Payload, header ...ResponseHeader)

Forbidden generate a Response with status code 403.

The server understood the request but refuses to authorize it.

A server that wishes to make public why the request has been forbidden can describe that reason in the Response payload (if any).

If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials. However, a request might be forbidden for reasons unrelated to the credentials.

An origin server that wishes to "hide" the current existence of a forbidden target resource MAY instead respond with a status code of 404 Not Found.

func (Response) Found ¶

func (r Response) Found(code string, payload Payload, header ...ResponseHeader)

Found generate a Response with status code 302.

The target resource resides temporarily under a different URI. Since the redirection might be altered on occasion, the client ought to continue to use the effective request URI for future requests.

The server SHOULD generate a Location header field in the Response containing a URI reference for the different URI. The user agent MAY use the Location field value for automatic redirection. The server's Response payload usually contains a short hypertext note with a hyperlink to the different URI(s).

Note: For historical reasons, a user agent MAY change the request method from POST to GET for the subsequent request. If this behavior is undesired, the 307 Temporary Redirect status code can be used instead.

func (Response) GatewayTimeout ¶

func (r Response) GatewayTimeout(code string, payload Payload, header ...ResponseHeader)

GatewayTimeout generate a Response with status code 504.

The server, while acting as a gateway or proxy, did not receive a timely Response from an upstream server it needed to access in order to complete the request.

func (Response) Gone ¶

func (r Response) Gone(code string, payload Payload, header ...ResponseHeader)

Gone generate a Response with status code 410.

The target resource is no longer available at the origin server and that this condition is likely to be permanent.

If the origin server does not know, or has no facility to determine, whether or not the condition is permanent, the status code 404 Not Found ought to be used instead.

The 410 Response is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable and that the server owners desire that remote links to that resource be removed. Such an event is common for limited-time, promotional services and for resources belonging to individuals no longer associated with the origin server's site. It is not necessary to mark all permanently unavailable resources as "gone" or to keep the mark for any length of time -- that is left to the discretion of the server owner.

A 410 Response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls.

func (Response) HTTPVersionNotSupported ¶

func (r Response) HTTPVersionNotSupported(code string, payload Payload, header ...ResponseHeader)

HTTPVersionNotSupported generate a Response with status code 505.

The server does not support, or refuses to support, the major version of HTTP that was used in the request message.

The server is indicating that it is unable or unwilling to complete the request using the same major version as the client, as described in Section 2.6 of RFC7230, other than with this error message. The server SHOULD generate a representation for the 505 Response that describes why that version is not supported and what other protocols are supported by that server.

func (Response) IMUsed ¶

func (r Response) IMUsed(code string, payload Payload, header ...ResponseHeader)

IMUsed generate a Response with status code 226.

The server has fulfilled a GET request for the resource, and the Response is a representation of the result of one or more instance-manipulations applied to the current instance.

The actual current instance might not be available except by combining this Response with other previous or future responses, as appropriate for the specific instance-manipulation(s). If so, the headers of the resulting instance are the result of combining the headers from the 226 Response and the other instances, following the rules in section 13.5.3 of the HTTP/1.1 specification.

The request MUST have included an A-IM header field listing at least one instance-manipulation. The Response MUST include an Etag header field giving the entity tag of the current instance.

A Response received with a status code of 226 MAY be stored by a cache and used in reply to a subsequent request, subject to the HTTP expiration mechanism and any Cache-Control headers, and to the requirements in section 10.6.

A Response received with a status code of 226 MAY be used by a cache, in conjunction with a cache entry for the base instance, to create a cache entry for the current instance.

func (Response) ImATeapot ¶

func (r Response) ImATeapot(code string, payload Payload, header ...ResponseHeader)

ImATeapot generate a Response with status code 418.

Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout.

func (Response) InsufficientStorage ¶

func (r Response) InsufficientStorage(code string, payload Payload, header ...ResponseHeader)

InsufficientStorage generate a Response with status code 507.

The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.

This condition is considered to be temporary. If the request that received this status code was the result of a user action, the request MUST NOT be repeated until it is requested by a separate user action.

func (Response) InternalServerError ¶

func (r Response) InternalServerError(code string, payload Payload, header ...ResponseHeader)

InternalServerError generate a Response with status code 500.

The server encountered an unexpected condition that prevented it from fulfilling the request.

func (Response) LengthRequired ¶

func (r Response) LengthRequired(code string, payload Payload, header ...ResponseHeader)

LengthRequired generate a Response with status code 411.

The server refuses to accept the request without a defined Content-Length.

The client MAY repeat the request if it adds a valid Content-Length header field containing the length of the message body in the request message.

func (Response) Locked ¶

func (r Response) Locked(code string, payload Payload, header ...ResponseHeader)

Locked generate a Response with status code 423.

The source or destination resource of a method is locked.

This Response SHOULD contain an appropriate precondition or postcondition code, such as 'lock-token-submitted' or 'no-conflicting-lock'.

func (Response) LoopDetected ¶

func (r Response) LoopDetected(code string, payload Payload, header ...ResponseHeader)

LoopDetected generate a Response with status code 508.

The server terminated an operation because it encountered an infinite loop while processing a request with "Depth: infinity". This status indicates that the entire operation failed.

func (Response) MethodNotAllowed ¶

func (r Response) MethodNotAllowed(code string, payload Payload, header ...ResponseHeader)

MethodNotAllowed generate a Response with status code 405.

The method received in the request-line is known by the origin server but not supported by the target resource.

The origin server MUST generate an Allow header field in a 405 Response containing a list of the target resource's currently supported methods.

A 405 Response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls.

func (Response) MisdirectedRequest ¶

func (r Response) MisdirectedRequest(code string, payload Payload, header ...ResponseHeader)

MisdirectedRequest generate a Response with status code 421.

The request was directed at a server that is not able to produce a Response. This can be sent by a server that is not configured to produce responses for the combination of scheme and authority that are included in the request URI.

Clients receiving a 421 Misdirected Request Response from a server MAY retry the request -- whether the request method is idempotent or not -- over a different connection. This is possible if a connection is reused or if an alternative service is selected ALT-SVC.

This status code MUST NOT be generated by proxies.

A 421 Response is cacheable by default, i.e., unless otherwise indicated by the method definition or explicit cache controls.

func (Response) MovedPermanently ¶

func (r Response) MovedPermanently(code string, payload Payload, header ...ResponseHeader)

MovedPermanently generate a Response with status code 301.

The target resource has been assigned a new permanent URI and any future references to this resource ought to use one of the enclosed URIs.

Clients with link-editing capabilities ought to automatically re-link references to the effective request URI to one or more of the new references sent by the server, where possible.

The server SHOULD generate a Location header field in the Response containing a preferred URI reference for the new permanent URI. The user agent MAY use the Location field value for automatic redirection. The server's Response payload usually contains a short hypertext note with a hyperlink to the new URI(s).

Note: For historical reasons, a user agent MAY change the request method from POST to GET for the subsequent request. If this behavior is undesired, the 307 Temporary Redirect status code can be used instead.

A 301 Response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls.

func (Response) MultiStatus ¶

func (r Response) MultiStatus(code string, payload Payload, header ...ResponseHeader)

MultiStatus generate a Response with status code 207.

A Multi-Status Response conveys information about multiple resources in situations where multiple status codes might be appropriate.

The default Multi-Status Response body is a text/xml or application/xml HTTP entity with a 'multistatus' root element. Further elements contain 200, 300, 400, and 500 series status codes generated during the method invocation. 100 series status codes SHOULD NOT be recorded in a 'Response' XML element.

Although '207' is used as the overall Response status code, the recipient needs to consult the contents of the multistatus Response body for further information about the success or failure of the method execution. The Response MAY be used in success, partial success and also in failure situations.

The 'multistatus' root element holds zero or more 'Response' elements in any order, each with information about an individual resource. Each 'Response' element MUST have an 'href' element to identify the resource.

A Multi-Status Response uses one out of two distinct formats for representing the status:

1. A 'status' element as child of the 'Response' element indicates the status of the message execution for the identified resource as a whole. Some method definitions provide information about specific status codes clients should be prepared to see in a Response. However, clients MUST be able to handle other status codes, using the generic rules defined in RFC2616 Section 10.

2. For PROPFIND and PROPPATCH, the format has been extended using the 'propstat' element instead of 'status', providing information about individual properties of a resource. This format is specific to PROPFIND and PROPPATCH, and is described in detail in RFC4918 Section 9.1 and RFC4918 Section 9.2.

func (Response) MultipleChoices ¶

func (r Response) MultipleChoices(code string, payload Payload, header ...ResponseHeader)

MultipleChoices generate a Response with status code 300.

The target resource has more than one representation, each with its own more specific identifier, and information about the alternatives is being provided so that the user (or user agent) can select a preferred representation by redirecting its request to one or more of those identifiers.

In other words, the server desires that the user agent engage in reactive negotiation to select the most appropriate representation(s) for its needs.

If the server has a preferred choice, the server SHOULD generate a Location header field containing a preferred choice's URI reference. The user agent MAY use the Location field value for automatic redirection.

For request methods other than HEAD, the server SHOULD generate a payload in the 300 Response containing a list of representation metadata and URI reference(s) from which the user or user agent can choose the one most preferred. The user agent MAY make a selection from that list automatically if it understands the provided media type. A specific format for automatic selection is not defined by this specification because HTTP tries to remain orthogonal to the definition of its payloads. In practice, the representation is provided in some easily parsed format believed to be acceptable to the user agent, as determined by shared design or content negotiation, or in some commonly accepted hypertext format.

A 300 Response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls.

Note: The original proposal for the 300 status code defined the URI header field as providing a list of alternative representations, such that it would be usable for 200, 300, and 406 responses and be transferred in responses to the HEAD method. However, lack of deployment and disagreement over syntax led to both URI and Alternates (a subsequent proposal) being dropped from this specification. It is possible to communicate the list using a set of Link header fields, each with a relationship of "alternate", though deployment is a chicken-and-egg problem.

func (Response) NetworkAuthenticationRequired ¶

func (r Response) NetworkAuthenticationRequired(code string, payload Payload, header ...ResponseHeader)

NetworkAuthenticationRequired generate a Response with status code 511.

The client needs to authenticate to gain network access.

The Response representation SHOULD contain a link to a resource that allows the user to submit credentials (e.g., with an HTML form).

Note that the 511 Response SHOULD NOT contain a challenge or the login interface itself, because browsers would show the login interface as being associated with the originally requested URL, which may cause confusion.

The 511 status SHOULD NOT be generated by origin servers; it is intended for use by intercepting proxies that are interposed as a means of controlling access to the network.

Responses with the 511 status code MUST NOT be stored by a cache.

The 511 status code is designed to mitigate problems caused by "captive portals" to software (especially non-browser agents) that is expecting a Response from the server that a request was made to, not the intervening network infrastructure. It is not intended to encourage deployment of captive portals -- only to limit the damage caused by them.

A network operator wishing to require some authentication, acceptance of terms, or other user interaction before granting access usually does so by identifying clients who have not done so ("unknown clients") using their Media Access Control (MAC) addresses.

Unknown clients then have all traffic blocked, except for that on TCP port 80, which is sent to an HTTP server (the "login server") dedicated to "logging in" unknown clients, and of course traffic to the login server itself.

For example, a user agent might connect to a network and make the following HTTP request on TCP port 80:

GET /index.htm HTTP/1.1
Host: www.example.com

Upon receiving such a request, the login server would generate a 511 Response:

HTTP/1.1 511 Network Authentication Required
Content-Type: text/html

<html>
 <head>
   <title>Network Authentication Required</title>
   <meta http-equiv="refresh" content="0; url=https://login.example.net/">
 </head>
 <body>
   <p>You need to <a href="https://login.example.net/">
   authenticate with the local network</a> in order to gain
   access.</p>
 </body>
</html>

Here, the 511 status code assures that non-browser clients will not interpret the Response as being from the origin server, and the META HTML element redirects the user agent to the login server.

func (Response) NetworkConnectTimeoutError ¶

func (r Response) NetworkConnectTimeoutError(code string, payload Payload, header ...ResponseHeader)

NetworkConnectTimeoutError generate a Response with status code 599.

This status code is not specified in any RFCs, but is used by some HTTP proxies to signal a network connect timeout behind the proxy to a client in front of the proxy.

func (Response) NoAuthoritativeInformation ¶

func (r Response) NoAuthoritativeInformation(code string, payload Payload, header ...ResponseHeader)

NoAuthoritativeInformation generate a Response with status code 203.

The request was successful but the enclosed payload has been modified from that of the origin server's 200 OK Response by a transforming proxy.

This status code allows the proxy to notify recipients when a transformation has been applied, since that knowledge might impact later decisions regarding the content. For example, future cache validation requests for the content might only be applicable along the same request path (through the same proxies).

The 203 Response is similar to the Warning code of 214 Transformation Applied, which has the advantage of being applicable to responses with any status code.

A 203 Response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls.

func (Response) NoContent ¶

func (r Response) NoContent(code string, payload Payload, header ...ResponseHeader)

NoContent generate a Response with status code 204.

The server has successfully fulfilled the request and that there is no additional content to send in the Response payload body.

Metadata in the Response header fields refer to the target resource and its selected representation after the requested action was applied.

For example, if a 204 status code is received in Response to a PUT request and the Response contains an ETag header field, then the PUT was successful and the ETag field-value contains the entity-tag for the new representation of that target resource.

The 204 Response allows a server to indicate that the action has been successfully applied to the target resource, while implying that the user agent does not need to traverse away from its current "document view" (if any). The server assumes that the user agent will provide some indication of the success to its user, in accord with its own interface, and apply any new or updated metadata in the Response to its active representation.

For example, a 204 status code is commonly used with document editing interfaces corresponding to a "save" action, such that the document being saved remains available to the user for editing. It is also frequently used with interfaces that expect automated data transfers to be prevalent, such as within distributed version control systems.

A 204 Response is terminated by the first empty line after the header fields because it cannot contain a message body.

A 204 Response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls.

func (Response) NotAcceptable ¶

func (r Response) NotAcceptable(code string, payload Payload, header ...ResponseHeader)

NotAcceptable generate a Response with status code 406.

The target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request, and the server is unwilling to supply a default representation.

The server SHOULD generate a payload containing a list of available representation characteristics and corresponding resource identifiers from which the user or user agent can choose the one most appropriate. A user agent MAY automatically select the most appropriate choice from that list. However, this specification does not define any standard for such automatic selection, as described in RFC7231 Section 6.4.1.

func (Response) NotExtended ¶

func (r Response) NotExtended(code string, payload Payload, header ...ResponseHeader)

NotExtended generate a Response with status code 510.

The policy for accessing the resource has not been met in the request. The server should send back all the information necessary for the client to issue an extended request.

It is outside the scope of this specification to specify how the extensions inform the client.

If the 510 Response contains information about extensions that were not present in the initial request then the client MAY repeat the request if it has reason to believe it can fulfill the extension policy by modifying the request according to the information provided in the 510 Response. Otherwise the client MAY present any entity included in the 510 Response to the user, since that entity may include relevant diagnostic information.

func (Response) NotFound ¶

func (r Response) NotFound(code string, payload Payload, header ...ResponseHeader)

NotFound generate a Response with status code 404.

The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

A 404 status code does not indicate whether this lack of representation is temporary or permanent; the 410 Gone status code is preferred over 404 if the origin server knows, presumably through some configurable means, that the condition is likely to be permanent.

A 404 Response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls.

func (Response) NotImplemented ¶

func (r Response) NotImplemented(code string, payload Payload, header ...ResponseHeader)

NotImplemented generate a Response with status code 501.

The server does not support the functionality required to fulfill the request.

This is the appropriate Response when the server does not recognize the request method and is not capable of supporting it for any resource.

A 501 Response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls.

func (Response) NotModified ¶

func (r Response) NotModified(code string, payload Payload, header ...ResponseHeader)

NotModified generate a Response with status code 304.

A conditional GET or HEAD request has been received and would have resulted in a 200 OK Response if it were not for the fact that the condition evaluated to false.

In other words, there is no need for the server to transfer a representation of the target resource because the request indicates that the client, which made the request conditional, already has a valid representation; the server is therefore redirecting the client to make use of that stored representation as if it were the payload of a 200 OK Response.

The server generating a 304 Response MUST generate any of the following header fields that would have been sent in a 200 OK Response to the same request: Cache-Control, Content-Location, Date, ETag, Expires, and Vary.

Since the goal of a 304 Response is to minimize information transfer when the recipient already has one or more cached representations, a sender SHOULD NOT generate representation metadata other than the above listed fields unless said metadata exists for the purpose of guiding cache updates (e.g., Last-Modified might be useful if the Response does not have an ETag field).

Requirements on a cache that receives a 304 Response are defined in Section 4.3.4 of RFC7234. If the conditional request originated with an outbound client, such as a user agent with its own cache sending a conditional GET to a shared proxy, then the proxy SHOULD forward the 304 Response to that client.

A 304 Response cannot contain a message-body; it is always terminated by the first empty line after the header fields.

func (Response) OK ¶

func (r Response) OK(code string, payload Payload, header ...ResponseHeader)

OK generate a Response with status code 200.

The request has succeeded.

The payload sent in a 200 Response depends on the request method. For the methods defined by this specification, the intended meaning of the payload can be summarized as:

• `GET` a representation of the target resource
• `HEAD` the same representation as `GET`, but without the representation data
• `POST` a representation of the status of, or results obtained from, the action;
• `PUT` `DELETE` a representation of the status of the action;
• `OPTIONS` a representation of the communications options;
• `TRACE` a representation of the request message as received by the end server.

Aside from responses to CONNECT, a 200 Response always has a payload, though an origin server MAY generate a payload body of zero length. If no payload is desired, an origin server ought to send 204 No Content instead. For CONNECT, no payload is allowed because the successful result is a tunnel, which begins immediately after the 200 Response header section.

A 200 Response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls.

func (Response) PartialContent ¶

func (r Response) PartialContent(code string, payload Payload, header ...ResponseHeader)

PartialContent generate a Response with status code 206.

The server is successfully fulfilling a range request for the target resource by transferring one or more parts of the selected representation that correspond to the satisfiable ranges found in the request's Range header field.

If a single part is being transferred, the server generating the 206 Response MUST generate a Content-Range header field, describing what range of the selected representation is enclosed, and a payload consisting of the range. For example:

HTTP/1.1 206 Partial Content
Date: Wed, 15 Nov 1995 06:25:24 GMT
Last-Modified: Wed, 15 Nov 1995 04:58:08 GMT
Content-Range: bytes 21010-47021/47022
Content-Length: 26012
Content-Type: image/gif

... 26012 bytes of partial image data ...

If multiple parts are being transferred, the server generating the 206 Response MUST generate a "multipart/byteranges" payload, and a Content-Type header field containing the multipart/byteranges media type and its required boundary parameter. To avoid confusion with single-part responses, a server MUST NOT generate a Content-Range header field in the HTTP header section of a multiple part Response (this field will be sent in each part instead).

Within the header area of each body part in the multipart payload, the server MUST generate a Content-Range header field corresponding to the range being enclosed in that body part. If the selected representation would have had a Content-Type header field in a 200 OK Response, the server SHOULD generate that same Content-Type field in the header area of each body part. For example:

HTTP/1.1 206 Partial Content
Date: Wed, 15 Nov 1995 06:25:24 GMT
Last-Modified: Wed, 15 Nov 1995 04:58:08 GMT
Content-Length: 1741
Content-Type: multipart/byteranges; boundary=THIS_STRING_SEPARATES

--THIS_STRING_SEPARATES
Content-Type: application/pdf
Content-Range: bytes 500-999/8000

...the first range...
--THIS_STRING_SEPARATES
Content-Type: application/pdf
Content-Range: bytes 7000-7999/8000

...the second range
--THIS_STRING_SEPARATES--

When multiple ranges are requested, a server MAY coalesce any of the ranges that overlap, or that are separated by a gap that is smaller than the overhead of sending multiple parts, regardless of the order in which the corresponding byte-range-spec appeared in the received Range header field. Since the typical overhead between parts of a multipart/byteranges payload is around 80 bytes, depending on the selected representation's media type and the chosen boundary parameter length, it can be less efficient to transfer many small disjoint parts than it is to transfer the entire selected representation.

A server MUST NOT generate a multipart Response to a request for a single range, since a client that does not request multiple parts might not support multipart responses. However, a server MAY generate a multipart/byteranges payload with only a single body part if multiple ranges were requested and only one range was found to be satisfiable or only one range remained after coalescing. A client that cannot process a multipart/byteranges Response MUST NOT generate a request that asks for multiple ranges.

When a multipart Response payload is generated, the server SHOULD send the parts in the same order that the corresponding byte-range-spec appeared in the received Range header field, excluding those ranges that were deemed unsatisfiable or that were coalesced into other ranges. A client that receives a multipart Response MUST inspect the Content-Range header field present in each body part in order to determine which range is contained in that body part; a client cannot rely on receiving the same ranges that it requested, nor the same order that it requested.

When a 206 Response is generated, the server MUST generate the following header fields, in addition to those required above, if the field would have been sent in a 200 OK Response to the same request: Date, Cache-Control, ETag, Expires, Content-Location, and Vary.

If a 206 is generated in Response to a request with an If-Range header field, the sender SHOULD NOT generate other representation header fields beyond those required above, because the client is understood to already have a prior Response containing those header fields. Otherwise, the sender MUST generate all of the representation header fields that would have been sent in a 200 OK Response to the same request.

A 206 Response is cacheable by default; i.e., unless otherwise indicated by explicit cache controls.

func (Response) PayloadTooLarge ¶

func (r Response) PayloadTooLarge(code string, payload Payload, header ...ResponseHeader)

PayloadTooLarge generate a Response with status code 413.

The server is refusing to process a request because the request payload is larger than the server is willing or able to process.

The server MAY close the connection to prevent the client from continuing the request.

If the condition is temporary, the server SHOULD generate a Retry-After header field to indicate that it is temporary and after what time the client MAY try again.

func (Response) PaymentRequired ¶

func (r Response) PaymentRequired(code string, payload Payload, header ...ResponseHeader)

PaymentRequired generate a Response with status code 402.

The 402 (Payment Required) status code is reserved for future use.

The original idea may have been that commercial websites and APIs would want to have a default way to communicate that a HTTP request can be repeated, after a user paid for service. The RFC suggests that it’s not a good idea to use this status code today, because it may get a better definition in the future, possibly making existing sites incompatible with HTTP.

That being said, it hasn't really stopped people from using the code anyway.

• The Shopify API uses it to indicate a “shop is frozen”.
• Pubnub also uses it to indicate that a feature needs to be paid for.
• Youtube may be using it to rate-limit abusers.

So should you use it? The RFC says no. But, I also don’t think there’s a major risk in doing so.

func (Response) PermanentRedirect ¶

func (r Response) PermanentRedirect(code string, payload Payload, header ...ResponseHeader)

PermanentRedirect generate a Response with status code 308.

The target resource has been assigned a new permanent URI and any future references to this resource ought to use one of the enclosed URIs.

Clients with link editing capabilities ought to automatically re-link references to the effective request URI to one or more of the new references sent by the server, where possible.

The server SHOULD generate a Location header field in the Response containing a preferred URI reference for the new permanent URI. The user agent MAY use the Location field value for automatic redirection. The server's Response payload usually contains a short hypertext note with a hyperlink to the new URI(s).

A 308 Response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls.

Note: This status code is similar to 301 Moved Permanently, except that it does not allow changing the request method from POST to GET.

func (Response) PreconditionFailed ¶

func (r Response) PreconditionFailed(code string, payload Payload, header ...ResponseHeader)

PreconditionFailed generate a Response with status code 412.

One or more conditions given in the request header fields evaluated to false when tested on the server.

This Response code allows the client to place preconditions on the current resource state (its current representations and metadata) and, thus, prevent the request method from being applied if the target resource is in an unexpected state.

func (Response) PreconditionRequired ¶

func (r Response) PreconditionRequired(code string, payload Payload, header ...ResponseHeader)

PreconditionRequired generate a Response with status code 428.

The origin server requires the request to be conditional.

Its typical use is to avoid the "lost update" problem, where a client GETs a resource's state, modifies it, and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict. By requiring requests to be conditional, the server can assure that clients are working with the correct copies.

Responses using this status code SHOULD explain how to resubmit the request successfully. For example:

HTTP/1.1 428 Precondition Required
Content-Type: text/html

<html>
 <head>
   <title>Precondition Required</title>
 </head>
 <body>
   <h1>Precondition Required</h1>
   <p>This request is required to be conditional; try using "If-Match".</p>
 </body>
</html>

Responses with the 428 status code MUST NOT be stored by a cache.

func (Response) Processing ¶

func (r Response) Processing(code string, payload Payload, header ...ResponseHeader)

Processing generate a Response with status code 102.

An interim Response used to inform the client that the server has accepted the complete request, but has not yet completed it.

This status code SHOULD only be sent when the server has a reasonable expectation that the request will take significant time to complete. As guidance, if a method is taking longer than 20 seconds (a reasonable, but arbitrary value) to process the server SHOULD return a 102 (Processing) Response. The server MUST send a final Response after the request has been completed.

Methods can potentially take a long period of time to process, especially methods that support the Depth header. In such cases the client may time-out the connection while waiting for a Response. To prevent this the server may return a 102 Processing status code to indicate to the client that the server is still processing the method.

func (Response) ProxyAuthRequired ¶

func (r Response) ProxyAuthRequired(code string, payload Payload, header ...ResponseHeader)

ProxyAuthRequired generate a Response with status code 407.

Similar to 401 Unauthorized, but it indicates that the client needs to authenticate itself in order to use a proxy.

The proxy MUST send a Proxy-Authenticate header field containing a challenge applicable to that proxy for the target resource. The client MAY repeat the request with a new or replaced Proxy-Authorization header field.

func (Response) RequestHeaderFieldsTooLarge ¶

func (r Response) RequestHeaderFieldsTooLarge(code string, payload Payload, header ...ResponseHeader)

RequestHeaderFieldsTooLarge generate a Response with status code 431.

The server is unwilling to process the request because its header fields are too large. The request MAY be resubmitted after reducing the size of the request header fields.

It can be used both when the set of request header fields in total is too large, and when a single header field is at fault. In the latter case, the Response representation SHOULD specify which header field was too large.

For example:

HTTP/1.1 431 Request Header Fields Too Large
Content-Type: text/html

<html>
 <head>
   <title>Request Header Fields Too Large</title>
 </head>
 <body>
   <h1>Request Header Fields Too Large</h1>
   <p>The "Example" header was too large.</p>
 </body>
</html>

Responses with the 431 status code MUST NOT be stored by a cache.

func (Response) RequestTimeout ¶

func (r Response) RequestTimeout(code string, payload Payload, header ...ResponseHeader)

RequestTimeout generate a Response with status code 408.

The server did not receive a complete request message within the time that it was prepared to wait.

A server SHOULD send the "close" connection option in the Response, since 408 implies that the server has decided to close the connection rather than continue waiting. If the client has an outstanding request in transit, the client MAY repeat that request on a new connection.

func (Response) RequestURITooLong ¶

func (r Response) RequestURITooLong(code string, payload Payload, header ...ResponseHeader)

RequestURITooLong generate a Response with status code 414.

The server is refusing to service the request because the request-target is longer than the server is willing to interpret.

This rare condition is only likely to occur when a client has improperly converted a POST request to a GET request with long query information, when the client has descended into a "black hole" of redirection (e.g., a redirected URI prefix that points to a suffix of itself) or when the server is under attack by a client attempting to exploit potential security holes.

A 414 Response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls.

func (Response) RequestedRangeNotSatisfiable ¶

func (r Response) RequestedRangeNotSatisfiable(code string, payload Payload, header ...ResponseHeader)

RequestedRangeNotSatisfiable generate a Response with status code 416.

None of the ranges in the request's Range header field overlap the current extent of the selected resource or that the set of ranges requested has been rejected due to invalid ranges or an excessive request of small or overlapping ranges.

For byte ranges, failing to overlap the current extent means that the first-byte-pos of all of the byte-range-spec values were greater than the current length of the selected representation. When this status code is generated in Response to a byte-range request, the sender SHOULD generate a Content-Range header field specifying the current length of the selected representation.

For example:

HTTP/1.1 416 Range Not Satisfiable
Date: Fri, 20 Jan 2012 15:41:54 GMT
Content-Range: bytes */47022

Note: Because servers are free to ignore Range, many implementations will simply respond with the entire selected representation in a 200 OK Response. That is partly because most clients are prepared to receive a 200 OK to complete the task (albeit less efficiently) and partly because clients might not stop making an invalid partial request until they have received a complete representation. Thus, clients cannot depend on receiving a 416 Range Not Satisfiable Response even when it is most appropriate.

func (Response) ResetContent ¶

func (r Response) ResetContent(code string, payload Payload, header ...ResponseHeader)

ResetContent generate a Response with status code 205.

The server has fulfilled the request and desires that the user agent reset the "document view", which caused the request to be sent, to its original state as received from the origin server.

This Response is intended to support a common data entry use case where the user receives content that supports data entry (a form, notepad, canvas, etc.), enters or manipulates data in that space, causes the entered data to be submitted in a request, and then the data entry mechanism is reset for the next entry so that the user can easily initiate another input action.

Since the 205 status code implies that no additional content will be provided, a server MUST NOT generate a payload in a 205 Response. In other words, a server MUST do one of the following for a 205 Response: a) indicate a zero-length body for the Response by including a Content-Length header field with a value of 0; b) indicate a zero-length payload for the Response by including a Transfer-Encoding header field with a value of chunked and a message body consisting of a single chunk of zero-length; or, c) close the connection immediately after sending the blank line terminating the header section.

func (Response) Response ¶

func (r Response) Response(code string, status http.StatusCode, payload Payload, headers ...ResponseHeader)

Response generate the response from given data

func (Response) SeeOther ¶

func (r Response) SeeOther(code string, payload Payload, header ...ResponseHeader)

SeeOther generate a Response with status code 303.

The server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, which is intended to provide an indirect Response to the original request.

A user agent can perform a retrieval request targeting that URI (a GET or HEAD request if using HTTP), which might also be redirected, and present the eventual result as an answer to the original request. Note that the new URI in the Location header field is not considered equivalent to the effective request URI.

This status code is applicable to any HTTP method. It is primarily used to allow the output of a POST action to redirect the user agent to a selected resource, since doing so provides the information corresponding to the POST Response in a form that can be separately identified, bookmarked, and cached, independent of the original request.

A 303 Response to a GET request indicates that the origin server does not have a representation of the target resource that can be transferred by the server over HTTP. However, the Location field value refers to a resource that is descriptive of the target resource, such that making a retrieval request on that other resource might result in a representation that is useful to recipients without implying that it represents the original target resource. Note that answers to the questions of what can be represented, what representations are adequate, and what might be a useful description are outside the scope of HTTP.

Except for responses to a HEAD request, the representation of a 303 Response ought to contain a short hypertext note with a hyperlink to the same URI reference provided in the Location header field.

func (Response) ServiceUnavailable ¶

func (r Response) ServiceUnavailable(code string, payload Payload, header ...ResponseHeader)

ServiceUnavailable generate a Response with status code 503.

The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.

The server MAY send a Retry-After header field to suggest an appropriate amount of time for the client to wait before retrying the request.

Note: The existence of the 503 status code does not imply that a server has to use it when becoming overloaded. Some servers might simply refuse the connection.

func (Response) SwitchingProtocols ¶

func (r Response) SwitchingProtocols(code string, payload Payload, header ...ResponseHeader)

SwitchingProtocols generate a Response with status code 101.

The server understands and is willing to comply with the client's request, via the Upgrade header field, for a change in the application protocol being used on this connection.

The server MUST generate an Upgrade header field in the Response that indicates which protocol(s) will be switched to immediately after the empty line that terminates the 101 Response.

It is assumed that the server will only agree to switch protocols when it is advantageous to do so. For example, switching to a newer version of HTTP might be advantageous over older versions, and switching to a real-time, synchronous protocol might be advantageous when delivering resources that use such features.

func (Response) TemporaryRedirect ¶

func (r Response) TemporaryRedirect(code string, payload Payload, header ...ResponseHeader)

TemporaryRedirect generate a Response with status code 307.

The target resource resides temporarily under a different URI and the user agent MUST NOT change the request method if it performs an automatic redirection to that URI.

Since the redirection can change over time, the client ought to continue using the original effective request URI for future requests.

The server SHOULD generate a Location header field in the Response containing a URI reference for the different URI. The user agent MAY use the Location field value for automatic redirection. The server's Response payload usually contains a short hypertext note with a hyperlink to the different URI(s).

Note: This status code is similar to 302 Found, except that it does not allow changing the request method from POST to GET. This specification defines no equivalent counterpart for 301 Moved Permanently (RFC7238, however, proposes defining the status code 308 Permanent Redirect for this purpose).

func (Response) TooManyRequests ¶

func (r Response) TooManyRequests(code string, payload Payload, header ...ResponseHeader)

TooManyRequests generate a Response with status code 429.

The user has sent too many requests in a given amount of time ("rate limiting").

The Response representations SHOULD include details explaining the condition, and MAY include a Retry-After header indicating how long to wait before making a new request.

For example:

HTTP/1.1 429 Too Many Requests
Content-Type: text/html
Retry-After: 3600

<html>
 <head>
   <title>Too Many Requests</title>
 </head>
 <body>
   <h1>Too Many Requests</h1>
   <p>I only allow 50 requests per hour to this Web site per
   logged in user. Try again soon.</p>
 </body>
</html>

Note that this specification does not define how the origin server identifies the user, nor how it counts requests. For example, an origin server that is limiting request rates can do so based upon counts of requests on a per-resource basis, across the entire server, or even among a set of servers. Likewise, it might identify the user by its authentication credentials, or a stateful cookie.

Responses with the 429 status code MUST NOT be stored by a cache.

func (Response) Unauthorized ¶

func (r Response) Unauthorized(code string, payload Payload, header ...ResponseHeader)

Unauthorized generate a Response with status code 401.

The request has not been applied because it lacks valid authentication credentials for the target resource.

The server generating a 401 Response MUST send a WWW-Authenticate header field containing at least one challenge applicable to the target resource.

If the request included authentication credentials, then the 401 Response indicates that authorization has been refused for those credentials. The user agent MAY repeat the request with a new or replaced Authorization header field. If the 401 Response contains the same challenge as the prior Response, and the user agent has already attempted authentication at least once, then the user agent SHOULD present the enclosed representation to the user, since it usually contains relevant diagnostic information.

func (Response) UnavailableForLegalReasons ¶

func (r Response) UnavailableForLegalReasons(code string, payload Payload, header ...ResponseHeader)

UnavailableForLegalReasons generate a Response with status code 451.

The server is denying access to the resource as a consequence of a legal demand.

The server in question might not be an origin server. This type of legal demand typically most directly affects the operations of ISPs and search engines.

Responses using this status code SHOULD include an explanation, in the Response body, of the details of the legal demand: the party making it, the applicable legislation or regulation, and what classes of person and resource it applies to. For example:

HTTP/1.1 451 Unavailable For Legal Reasons
Link: <https://spqr.example.org/legislatione>; rel="blocked-by"
Content-Type: text/html

<html>
 <head>
   <title>Unavailable For Legal Reasons</title>
 </head>
 <body>
   <h1>Unavailable For Legal Reasons</h1>
   <p>This request may not be serviced in the Roman Province
   of Judea due to the Lex Julia Majestatis, which disallows
   access to resources hosted on servers deemed to be
   operated by the People's Front of Judea.</p>
 </body>
</html>

The use of the 451 status code implies neither the existence nor non-existence of the resource named in the request. That is to say, it is possible that if the legal demands were removed, a request for the resource still might not succeed.

Note that in many cases clients can still access the denied resource by using technical countermeasures such as a VPN or the Tor network.

A 451 Response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls; see RFC7234.

func (Response) UnprocessableEntity ¶

func (r Response) UnprocessableEntity(code string, payload Payload, header ...ResponseHeader)

UnprocessableEntity generate a Response with status code 422.

The server understands the content type of the request entity (hence a 415 Unsupported Media Type status code is inappropriate), and the syntax of the request entity is correct (thus a 400 Bad Request status code is inappropriate) but was unable to process the contained instructions.

For example, this error condition may occur if an XML request body contains well-formed (i.e., syntactically correct), but semantically erroneous, XML instructions.

func (Response) UnsupportedMediaType ¶

func (r Response) UnsupportedMediaType(code string, payload Payload, header ...ResponseHeader)

UnsupportedMediaType generate a Response with status code 415.

The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.

The format problem might be due to the request's indicated Content-Type or Content-Encoding, or as a result of inspecting the data directly.

func (Response) UpgradeRequired ¶

func (r Response) UpgradeRequired(code string, payload Payload, header ...ResponseHeader)

UpgradeRequired generate a Response with status code 426.

The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol.

The server MUST send an Upgrade header field in a 426 Response to indicate the required protocol(s)

Example:

HTTP/1.1 426 Upgrade Required
Upgrade: HTTP/3.0
Connection: Upgrade
Content-Length: 53
Content-Type: text/plain

This service requires use of the HTTP/3.0 protocol.

func (Response) UseProxy ¶

func (r Response) UseProxy(code string, payload Payload, header ...ResponseHeader)

UseProxy generate a Response with status code 305.

Defined in a previous version of this specification and is now deprecated, due to security concerns regarding in-band configuration of a proxy.

func (Response) VariantAlsoNegotiates ¶

func (r Response) VariantAlsoNegotiates(code string, payload Payload, header ...ResponseHeader)

VariantAlsoNegotiates generate a Response with status code 506.

The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.