Involved Source Filesclient.goclone.gocookie.go Package http provides HTTP client and server implementations.
[Get], [Head], [Post], and [PostForm] make HTTP (or HTTPS) requests:
resp, err := http.Get("http://example.com/")
...
resp, err := http.Post("http://example.com/upload", "image/jpeg", &buf)
...
resp, err := http.PostForm("http://example.com/form",
url.Values{"key": {"Value"}, "id": {"123"}})
The caller must close the response body when finished with it:
resp, err := http.Get("http://example.com/")
if err != nil {
// handle error
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
// ...
# Clients and Transports
For control over HTTP client headers, redirect policy, and other
settings, create a [Client]:
client := &http.Client{
CheckRedirect: redirectPolicyFunc,
}
resp, err := client.Get("http://example.com")
// ...
req, err := http.NewRequest("GET", "http://example.com", nil)
// ...
req.Header.Add("If-None-Match", `W/"wyzzy"`)
resp, err := client.Do(req)
// ...
For control over proxies, TLS configuration, keep-alives,
compression, and other settings, create a [Transport]:
tr := &http.Transport{
MaxIdleConns: 10,
IdleConnTimeout: 30 * time.Second,
DisableCompression: true,
}
client := &http.Client{Transport: tr}
resp, err := client.Get("https://example.com")
Clients and Transports are safe for concurrent use by multiple
goroutines and for efficiency should only be created once and re-used.
# Servers
ListenAndServe starts an HTTP server with a given address and handler.
The handler is usually nil, which means to use [DefaultServeMux].
[Handle] and [HandleFunc] add handlers to [DefaultServeMux]:
http.Handle("/foo", fooHandler)
http.HandleFunc("/bar", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Hello, %q", html.EscapeString(r.URL.Path))
})
log.Fatal(http.ListenAndServe(":8080", nil))
More control over the server's behavior is available by creating a
custom Server:
s := &http.Server{
Addr: ":8080",
Handler: myHandler,
ReadTimeout: 10 * time.Second,
WriteTimeout: 10 * time.Second,
MaxHeaderBytes: 1 << 20,
}
log.Fatal(s.ListenAndServe())
# HTTP/2
Starting with Go 1.6, the http package has transparent support for the
HTTP/2 protocol when using HTTPS. Programs that must disable HTTP/2
can do so by setting [Transport.TLSNextProto] (for clients) or
[Server.TLSNextProto] (for servers) to a non-nil, empty
map. Alternatively, the following GODEBUG settings are
currently supported:
GODEBUG=http2client=0 # disable HTTP/2 client support
GODEBUG=http2server=0 # disable HTTP/2 server support
GODEBUG=http2debug=1 # enable verbose HTTP/2 debug logs
GODEBUG=http2debug=2 # ... even more verbose, with frame dumps
Please report any issues before disabling HTTP/2 support: https://golang.org/s/http2bug
The http package's [Transport] and [Server] both automatically enable
HTTP/2 support for simple configurations. To enable HTTP/2 for more
complex configurations, to use lower-level HTTP/2 features, or to use
a newer version of Go's http2 package, import "golang.org/x/net/http2"
directly and use its ConfigureTransport and/or ConfigureServer
functions. Manually configuring HTTP/2 via the golang.org/x/net/http2
package takes precedence over the net/http package's built-in HTTP/2
support.filetransport.gofs.goh2_bundle.goh2_error.goheader.gohttp.gojar.gomapping.gomethod.gopattern.gorequest.goresponse.goresponsecontroller.goroundtrip.gorouting_index.gorouting_tree.goservemux121.goserver.gosniff.gosocks_bundle.gostatus.gotransfer.gotransport.gotransport_default_other.go
Code Examples
package main
import (
"log"
"net/http"
)
func main() {
// Simple static webserver:
log.Fatal(http.ListenAndServe(":8080", http.FileServer(http.Dir("/usr/share/doc"))))
}
package main
import (
"io/fs"
"log"
"net/http"
"strings"
)
// containsDotFile reports whether name contains a path element starting with a period.
// The name is assumed to be a delimited by forward slashes, as guaranteed
// by the http.FileSystem interface.
func containsDotFile(name string) bool {
parts := strings.Split(name, "/")
for _, part := range parts {
if strings.HasPrefix(part, ".") {
return true
}
}
return false
}
// dotFileHidingFile is the http.File use in dotFileHidingFileSystem.
// It is used to wrap the Readdir method of http.File so that we can
// remove files and directories that start with a period from its output.
type dotFileHidingFile struct {
http.File
}
// Readdir is a wrapper around the Readdir method of the embedded File
// that filters out all files that start with a period in their name.
func (f dotFileHidingFile) Readdir(n int) (fis []fs.FileInfo, err error) {
files, err := f.File.Readdir(n)
for _, file := range files { // Filters out the dot files
if !strings.HasPrefix(file.Name(), ".") {
fis = append(fis, file)
}
}
return
}
// dotFileHidingFileSystem is an http.FileSystem that hides
// hidden "dot files" from being served.
type dotFileHidingFileSystem struct {
http.FileSystem
}
// Open is a wrapper around the Open method of the embedded FileSystem
// that serves a 403 permission error when name has a file or directory
// with whose name starts with a period in its path.
func (fsys dotFileHidingFileSystem) Open(name string) (http.File, error) {
if containsDotFile(name) { // If dot file, return 403 response
return nil, fs.ErrPermission
}
file, err := fsys.FileSystem.Open(name)
if err != nil {
return nil, err
}
return dotFileHidingFile{file}, err
}
func main() {
fsys := dotFileHidingFileSystem{http.Dir(".")}
http.Handle("/", http.FileServer(fsys))
log.Fatal(http.ListenAndServe(":8080", nil))
}
package main
import (
"net/http"
)
func main() {
// To serve a directory on disk (/tmp) under an alternate URL
// path (/tmpfiles/), use StripPrefix to modify the request
// URL's path before the FileServer sees it:
http.Handle("/tmpfiles/", http.StripPrefix("/tmpfiles/", http.FileServer(http.Dir("/tmp"))))
}
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
res, err := http.Get("http://www.google.com/robots.txt")
if err != nil {
log.Fatal(err)
}
body, err := io.ReadAll(res.Body)
res.Body.Close()
if res.StatusCode > 299 {
log.Fatalf("Response failed with status code: %d and\nbody: %s\n", res.StatusCode, body)
}
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s", body)
}
package main
import (
"fmt"
"log"
"net/http"
"sync"
)
type countHandler struct {
mu sync.Mutex // guards n
n int
}
func (h *countHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
h.mu.Lock()
defer h.mu.Unlock()
h.n++
fmt.Fprintf(w, "count is %d\n", h.n)
}
func main() {
http.Handle("/count", new(countHandler))
log.Fatal(http.ListenAndServe(":8080", nil))
}
package main
import (
"io"
"log"
"net/http"
)
func main() {
h1 := func(w http.ResponseWriter, _ *http.Request) {
io.WriteString(w, "Hello from a HandleFunc #1!\n")
}
h2 := func(w http.ResponseWriter, _ *http.Request) {
io.WriteString(w, "Hello from a HandleFunc #2!\n")
}
http.HandleFunc("/", h1)
http.HandleFunc("/endpoint", h2)
log.Fatal(http.ListenAndServe(":8080", nil))
}
package main
import (
"fmt"
"log"
"net/http"
)
func main() {
http.HandleFunc("/hijack", func(w http.ResponseWriter, r *http.Request) {
hj, ok := w.(http.Hijacker)
if !ok {
http.Error(w, "webserver doesn't support hijacking", http.StatusInternalServerError)
return
}
conn, bufrw, err := hj.Hijack()
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
// Don't forget to close the connection:
defer conn.Close()
bufrw.WriteString("Now we're speaking raw TCP. Say hi: ")
bufrw.Flush()
s, err := bufrw.ReadString('\n')
if err != nil {
log.Printf("error reading string: %v", err)
return
}
fmt.Fprintf(bufrw, "You said: %q\nBye.\n", s)
bufrw.Flush()
})
}
package main
import (
"io"
"log"
"net/http"
)
func main() {
// Hello world, the web server
helloHandler := func(w http.ResponseWriter, req *http.Request) {
io.WriteString(w, "Hello, world!\n")
}
http.HandleFunc("/hello", helloHandler)
log.Fatal(http.ListenAndServe(":8080", nil))
}
package main
import (
"io"
"log"
"net/http"
)
func main() {
http.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
io.WriteString(w, "Hello, TLS!\n")
})
// One can use generate_cert.go in crypto/tls to generate cert.pem and key.pem.
log.Printf("About to listen on 8443. Go to https://127.0.0.1:8443/")
err := http.ListenAndServeTLS(":8443", "cert.pem", "key.pem", nil)
log.Fatal(err)
}
package main
import (
"fmt"
"log"
"net/http"
)
func newPeopleHandler() http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintln(w, "This is the people handler.")
})
}
func main() {
mux := http.NewServeMux()
// Create sample handler to returns 404
mux.Handle("/resources", http.NotFoundHandler())
// Create sample handler that returns 200
mux.Handle("/resources/people/", newPeopleHandler())
log.Fatal(http.ListenAndServe(":8080", mux))
}
package main
import (
"io"
"net/http"
)
func main() {
mux := http.NewServeMux()
mux.HandleFunc("/sendstrailers", func(w http.ResponseWriter, req *http.Request) {
// Before any call to WriteHeader or Write, declare
// the trailers you will set during the HTTP
// response. These three headers are actually sent in
// the trailer.
w.Header().Set("Trailer", "AtEnd1, AtEnd2")
w.Header().Add("Trailer", "AtEnd3")
w.Header().Set("Content-Type", "text/plain; charset=utf-8") // normal header
w.WriteHeader(http.StatusOK)
w.Header().Set("AtEnd1", "value 1")
io.WriteString(w, "This HTTP response has both headers before this text and trailers at the end.\n")
w.Header().Set("AtEnd2", "value 2")
w.Header().Set("AtEnd3", "value 3") // These will appear as trailers.
})
}
package main
import (
"fmt"
"net/http"
)
type apiHandler struct{}
func (apiHandler) ServeHTTP(http.ResponseWriter, *http.Request) {}
func main() {
mux := http.NewServeMux()
mux.Handle("/api/", apiHandler{})
mux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
// The "/" pattern matches everything, so we need to check
// that we're at the root here.
if req.URL.Path != "/" {
http.NotFound(w, req)
return
}
fmt.Fprintf(w, "Welcome to the home page!")
})
}
package main
import (
"context"
"log"
"net/http"
"os"
"os/signal"
)
func main() {
var srv http.Server
idleConnsClosed := make(chan struct{})
go func() {
sigint := make(chan os.Signal, 1)
signal.Notify(sigint, os.Interrupt)
<-sigint
// We received an interrupt signal, shut down.
if err := srv.Shutdown(context.Background()); err != nil {
// Error from closing listeners, or context timeout:
log.Printf("HTTP server Shutdown: %v", err)
}
close(idleConnsClosed)
}()
if err := srv.ListenAndServe(); err != http.ErrServerClosed {
// Error starting or closing listener:
log.Fatalf("HTTP server ListenAndServe: %v", err)
}
<-idleConnsClosed
}
package main
import (
"net/http"
)
func main() {
// To serve a directory on disk (/tmp) under an alternate URL
// path (/tmpfiles/), use StripPrefix to modify the request
// URL's path before the FileServer sees it:
http.Handle("/tmpfiles/", http.StripPrefix("/tmpfiles/", http.FileServer(http.Dir("/tmp"))))
}
Package-Level Type Names (total 26)
/* sort by: | */
A Client is an HTTP client. Its zero value ([DefaultClient]) is a
usable client that uses [DefaultTransport].
The [Client.Transport] typically has internal state (cached TCP
connections), so Clients should be reused instead of created as
needed. Clients are safe for concurrent use by multiple goroutines.
A Client is higher-level than a [RoundTripper] (such as [Transport])
and additionally handles HTTP details such as cookies and
redirects.
When following redirects, the Client will forward all headers set on the
initial [Request] except:
- when forwarding sensitive headers like "Authorization",
"WWW-Authenticate", and "Cookie" to untrusted targets.
These headers will be ignored when following a redirect to a domain
that is not a subdomain match or exact match of the initial domain.
For example, a redirect from "foo.com" to either "foo.com" or "sub.foo.com"
will forward the sensitive headers, but a redirect to "bar.com" will not.
- when forwarding the "Cookie" header with a non-nil cookie Jar.
Since each redirect may mutate the state of the cookie jar,
a redirect may possibly alter a cookie set in the initial request.
When forwarding the "Cookie" header, any mutated cookies will be omitted,
with the expectation that the Jar will insert those mutated cookies
with the updated values (assuming the origin matches).
If Jar is nil, the initial cookies are forwarded without change. CheckRedirect specifies the policy for handling redirects.
If CheckRedirect is not nil, the client calls it before
following an HTTP redirect. The arguments req and via are
the upcoming request and the requests made already, oldest
first. If CheckRedirect returns an error, the Client's Get
method returns both the previous Response (with its Body
closed) and CheckRedirect's error (wrapped in a url.Error)
instead of issuing the Request req.
As a special case, if CheckRedirect returns ErrUseLastResponse,
then the most recent response is returned with its body
unclosed, along with a nil error.
If CheckRedirect is nil, the Client uses its default policy,
which is to stop after 10 consecutive requests. Jar specifies the cookie jar.
The Jar is used to insert relevant cookies into every
outbound Request and is updated with the cookie values
of every inbound Response. The Jar is consulted for every
redirect that the Client follows.
If Jar is nil, cookies are only sent if they are explicitly
set on the Request. Timeout specifies a time limit for requests made by this
Client. The timeout includes connection time, any
redirects, and reading the response body. The timer remains
running after Get, Head, Post, or Do return and will
interrupt reading of the Response.Body.
A Timeout of zero means no timeout.
The Client cancels requests to the underlying Transport
as if the Request's Context ended.
For compatibility, the Client will also use the deprecated
CancelRequest method on Transport if found. New
RoundTripper implementations should use the Request's Context
for cancellation instead of implementing CancelRequest. Transport specifies the mechanism by which individual
HTTP requests are made.
If nil, DefaultTransport is used. CloseIdleConnections closes any connections on its [Transport] which
were previously connected from previous requests but are now
sitting idle in a "keep-alive" state. It does not interrupt any
connections currently in use.
If [Client.Transport] does not have a [Client.CloseIdleConnections] method
then this method does nothing. Do sends an HTTP request and returns an HTTP response, following
policy (such as redirects, cookies, auth) as configured on the
client.
An error is returned if caused by client policy (such as
CheckRedirect), or failure to speak HTTP (such as a network
connectivity problem). A non-2xx status code doesn't cause an
error.
If the returned error is nil, the [Response] will contain a non-nil
Body which the user is expected to close. If the Body is not both
read to EOF and closed, the [Client]'s underlying [RoundTripper]
(typically [Transport]) may not be able to re-use a persistent TCP
connection to the server for a subsequent "keep-alive" request.
The request Body, if non-nil, will be closed by the underlying
Transport, even on errors. The Body may be closed asynchronously after
Do returns.
On error, any Response can be ignored. A non-nil Response with a
non-nil error only occurs when CheckRedirect fails, and even then
the returned [Response.Body] is already closed.
Generally [Get], [Post], or [PostForm] will be used instead of Do.
If the server replies with a redirect, the Client first uses the
CheckRedirect function to determine whether the redirect should be
followed. If permitted, a 301, 302, or 303 redirect causes
subsequent requests to use HTTP method GET
(or HEAD if the original request was HEAD), with no body.
A 307 or 308 redirect preserves the original HTTP method and body,
provided that the [Request.GetBody] function is defined.
The [NewRequest] function automatically sets GetBody for common
standard library body types.
Any returned error will be of type [*url.Error]. The url.Error
value's Timeout method will report true if the request timed out. Get issues a GET to the specified URL. If the response is one of the
following redirect codes, Get follows the redirect after calling the
[Client.CheckRedirect] function:
301 (Moved Permanently)
302 (Found)
303 (See Other)
307 (Temporary Redirect)
308 (Permanent Redirect)
An error is returned if the [Client.CheckRedirect] function fails
or if there was an HTTP protocol error. A non-2xx response doesn't
cause an error. Any returned error will be of type [*url.Error]. The
url.Error value's Timeout method will report true if the request
timed out.
When err is nil, resp always contains a non-nil resp.Body.
Caller should close resp.Body when done reading from it.
To make a request with custom headers, use [NewRequest] and [Client.Do].
To make a request with a specified context.Context, use [NewRequestWithContext]
and Client.Do. Head issues a HEAD to the specified URL. If the response is one of the
following redirect codes, Head follows the redirect after calling the
[Client.CheckRedirect] function:
301 (Moved Permanently)
302 (Found)
303 (See Other)
307 (Temporary Redirect)
308 (Permanent Redirect)
To make a request with a specified [context.Context], use [NewRequestWithContext]
and [Client.Do]. Post issues a POST to the specified URL.
Caller should close resp.Body when done reading from it.
If the provided body is an [io.Closer], it is closed after the
request.
To set custom headers, use [NewRequest] and [Client.Do].
To make a request with a specified context.Context, use [NewRequestWithContext]
and [Client.Do].
See the Client.Do method documentation for details on how redirects
are handled. PostForm issues a POST to the specified URL,
with data's keys and values URL-encoded as the request body.
The Content-Type header is set to application/x-www-form-urlencoded.
To set other headers, use [NewRequest] and [Client.Do].
When err is nil, resp always contains a non-nil resp.Body.
Caller should close resp.Body when done reading from it.
See the Client.Do method documentation for details on how redirects
are handled.
To make a request with a specified context.Context, use [NewRequestWithContext]
and Client.Do.
func net/http/httptest.(*Server).Client() *Client
var DefaultClient *Client
The CloseNotifier interface is implemented by ResponseWriters which
allow detecting when the underlying connection has gone away.
This mechanism can be used to cancel long operations on the server
if the client has disconnected before the response is ready.
Deprecated: the CloseNotifier interface predates Go's context package.
New code should use [Request.Context] instead. CloseNotify returns a channel that receives at most a
single value (true) when the client connection has gone
away.
CloseNotify may wait to notify until Request.Body has been
fully read.
After the Handler has returned, there is no guarantee
that the channel receives a value.
If the protocol is HTTP/1.1 and CloseNotify is called while
processing an idempotent request (such as GET) while
HTTP/1.1 pipelining is in use, the arrival of a subsequent
pipelined request may cause a value to be sent on the
returned channel. In practice HTTP/1.1 pipelining is not
enabled in browsers and not seen often in the wild. If this
is a problem, use HTTP/2 or only use CloseNotify on methods
such as POST.
A CookieJar manages storage and use of cookies in HTTP requests.
Implementations of CookieJar must be safe for concurrent use by multiple
goroutines.
The net/http/cookiejar package provides a CookieJar implementation. Cookies returns the cookies to send in a request for the given URL.
It is up to the implementation to honor the standard cookie use
restrictions such as in RFC 6265. SetCookies handles the receipt of the cookies in a reply for the
given URL. It may or may not choose to save the cookies, depending
on the jar's policy and implementation.
*net/http/cookiejar.Jar
A Dir implements [FileSystem] using the native file system restricted to a
specific directory tree.
While the [FileSystem.Open] method takes '/'-separated paths, a Dir's string
value is a directory path on the native file system, not a URL, so it is separated
by [filepath.Separator], which isn't necessarily '/'.
Note that Dir could expose sensitive files and directories. Dir will follow
symlinks pointing out of the directory tree, which can be especially dangerous
if serving from a directory in which users are able to create arbitrary symlinks.
Dir will also allow access to files and directories starting with a period,
which could expose sensitive directories like .git or sensitive files like
.htpasswd. To exclude files with a leading period, remove the files/directories
from the server or create a custom FileSystem implementation.
An empty Dir is treated as ".". Open implements [FileSystem] using [os.Open], opening files for reading rooted
and relative to the directory d.
Dir : FileSystem
A FileSystem implements access to a collection of named files.
The elements in a file path are separated by slash ('/', U+002F)
characters, regardless of host operating system convention.
See the [FileServer] function to convert a FileSystem to a [Handler].
This interface predates the [fs.FS] interface, which can be used instead:
the [FS] adapter function converts an fs.FS to a FileSystem.( FileSystem) Open(name string) (File, error)Dir
func FS(fsys fs.FS) FileSystem
func FileServer(root FileSystem) Handler
func NewFileTransport(fs FileSystem) RoundTripper
The Flusher interface is implemented by ResponseWriters that allow
an HTTP handler to flush buffered data to the client.
The default HTTP/1.x and HTTP/2 [ResponseWriter] implementations
support [Flusher], but ResponseWriter wrappers may not. Handlers
should always test for this ability at runtime.
Note that even for ResponseWriters that support Flush,
if the client is connected through an HTTP proxy,
the buffered data may not reach the client until the response
completes. Flush sends any buffered data to the client.
*net/http/httptest.ResponseRecorder
*encoding/csv.Writer
*internal/trace/traceviewer.Emitter
A Header represents the key-value pairs in an HTTP header.
The keys should be in canonical form, as returned by
[CanonicalHeaderKey]. Add adds the key, value pair to the header.
It appends to any existing values associated with key.
The key is case insensitive; it is canonicalized by
[CanonicalHeaderKey]. Clone returns a copy of h or nil if h is nil. Del deletes the values associated with key.
The key is case insensitive; it is canonicalized by
[CanonicalHeaderKey]. Get gets the first value associated with the given key. If
there are no values associated with the key, Get returns "".
It is case insensitive; [textproto.CanonicalMIMEHeaderKey] is
used to canonicalize the provided key. Get assumes that all
keys are stored in canonical form. To use non-canonical keys,
access the map directly. Set sets the header entries associated with key to the
single element value. It replaces any existing values
associated with key. The key is case insensitive; it is
canonicalized by [textproto.CanonicalMIMEHeaderKey].
To use non-canonical keys, assign to the map directly. Values returns all values associated with the given key.
It is case insensitive; [textproto.CanonicalMIMEHeaderKey] is
used to canonicalize the provided key. To use non-canonical
keys, access the map directly.
The returned slice is not a copy. Write writes a header in wire format. WriteSubset writes a header in wire format.
If exclude is not nil, keys where exclude[key] == true are not written.
Keys are not canonicalized before checking the exclude map.
func Header.Clone() Header
func ResponseWriter.Header() Header
func net/http/httptest.(*ResponseRecorder).Header() Header
The Hijacker interface is implemented by ResponseWriters that allow
an HTTP handler to take over the connection.
The default [ResponseWriter] for HTTP/1.x connections supports
Hijacker, but HTTP/2 connections intentionally do not.
ResponseWriter wrappers may also not support Hijacker. Handlers
should always test for this ability at runtime. Hijack lets the caller take over the connection.
After a call to Hijack the HTTP server library
will not do anything else with the connection.
It becomes the caller's responsibility to manage
and close the connection.
The returned net.Conn may have read or write deadlines
already set, depending on the configuration of the
Server. It is the caller's responsibility to set
or clear those deadlines as needed.
The returned bufio.Reader may contain unprocessed buffered
data from the client.
After a call to Hijack, the original Request.Body must not
be used. The original Request's Context remains valid and
is not canceled until the Request's ServeHTTP method
returns.
*ResponseController
Pusher is the interface implemented by ResponseWriters that support
HTTP/2 server push. For more background, see
https://tools.ietf.org/html/rfc7540#section-8.2. Push initiates an HTTP/2 server push. This constructs a synthetic
request using the given target and options, serializes that request
into a PUSH_PROMISE frame, then dispatches that request using the
server's request handler. If opts is nil, default options are used.
The target must either be an absolute path (like "/path") or an absolute
URL that contains a valid host and the same scheme as the parent request.
If the target is a path, it will inherit the scheme and host of the
parent request.
The HTTP/2 spec disallows recursive pushes and cross-authority pushes.
Push may or may not detect these invalid pushes; however, invalid
pushes will be detected and canceled by conforming clients.
Handlers that wish to push URL X should call Push before sending any
data that may trigger a request for URL X. This avoids a race where the
client issues requests for X before receiving the PUSH_PROMISE for X.
Push will run in a separate goroutine making the order of arrival
non-deterministic. Any required synchronization needs to be implemented
by the caller.
Push returns ErrNotSupported if the client has disabled push or if push
is not supported on the underlying connection.
PushOptions describes options for [Pusher.Push]. Header specifies additional promised request headers. This cannot
include HTTP/2 pseudo header fields like ":path" and ":scheme",
which will be added automatically. Method specifies the HTTP method for the promised request.
If set, it must be "GET" or "HEAD". Empty means "GET".
func Pusher.Push(target string, opts *PushOptions) error
A Request represents an HTTP request received by a server
or to be sent by a client.
The field semantics differ slightly between client and server
usage. In addition to the notes on the fields below, see the
documentation for [Request.Write] and [RoundTripper]. Body is the request's body.
For client requests, a nil body means the request has no
body, such as a GET request. The HTTP Client's Transport
is responsible for calling the Close method.
For server requests, the Request Body is always non-nil
but will return EOF immediately when no body is present.
The Server will close the request body. The ServeHTTP
Handler does not need to.
Body must allow Read to be called concurrently with Close.
In particular, calling Close should unblock a Read waiting
for input. Cancel is an optional channel whose closure indicates that the client
request should be regarded as canceled. Not all implementations of
RoundTripper may support Cancel.
For server requests, this field is not applicable.
Deprecated: Set the Request's context with NewRequestWithContext
instead. If a Request's Cancel field and context are both
set, it is undefined whether Cancel is respected. Close indicates whether to close the connection after
replying to this request (for servers) or after sending this
request and reading its response (for clients).
For server requests, the HTTP server handles this automatically
and this field is not needed by Handlers.
For client requests, setting this field prevents re-use of
TCP connections between requests to the same hosts, as if
Transport.DisableKeepAlives were set. ContentLength records the length of the associated content.
The value -1 indicates that the length is unknown.
Values >= 0 indicate that the given number of bytes may
be read from Body.
For client requests, a value of 0 with a non-nil Body is
also treated as unknown. Form contains the parsed form data, including both the URL
field's query parameters and the PATCH, POST, or PUT form data.
This field is only available after ParseForm is called.
The HTTP client ignores Form and uses Body instead. GetBody defines an optional func to return a new copy of
Body. It is used for client requests when a redirect requires
reading the body more than once. Use of GetBody still
requires setting Body.
For server requests, it is unused. Header contains the request header fields either received
by the server or to be sent by the client.
If a server received a request with header lines,
Host: example.com
accept-encoding: gzip, deflate
Accept-Language: en-us
fOO: Bar
foo: two
then
Header = map[string][]string{
"Accept-Encoding": {"gzip, deflate"},
"Accept-Language": {"en-us"},
"Foo": {"Bar", "two"},
}
For incoming requests, the Host header is promoted to the
Request.Host field and removed from the Header map.
HTTP defines that header names are case-insensitive. The
request parser implements this by using CanonicalHeaderKey,
making the first character and any characters following a
hyphen uppercase and the rest lowercase.
For client requests, certain headers such as Content-Length
and Connection are automatically written when needed and
values in Header may be ignored. See the documentation
for the Request.Write method. For server requests, Host specifies the host on which the
URL is sought. For HTTP/1 (per RFC 7230, section 5.4), this
is either the value of the "Host" header or the host name
given in the URL itself. For HTTP/2, it is the value of the
":authority" pseudo-header field.
It may be of the form "host:port". For international domain
names, Host may be in Punycode or Unicode form. Use
golang.org/x/net/idna to convert it to either format if
needed.
To prevent DNS rebinding attacks, server Handlers should
validate that the Host header has a value for which the
Handler considers itself authoritative. The included
ServeMux supports patterns registered to particular host
names and thus protects its registered Handlers.
For client requests, Host optionally overrides the Host
header to send. If empty, the Request.Write method uses
the value of URL.Host. Host may contain an international
domain name. Method specifies the HTTP method (GET, POST, PUT, etc.).
For client requests, an empty string means GET. MultipartForm is the parsed multipart form, including file uploads.
This field is only available after ParseMultipartForm is called.
The HTTP client ignores MultipartForm and uses Body instead. Pattern is the [ServeMux] pattern that matched the request.
It is empty if the request was not matched against a pattern. PostForm contains the parsed form data from PATCH, POST
or PUT body parameters.
This field is only available after ParseForm is called.
The HTTP client ignores PostForm and uses Body instead. The protocol version for incoming server requests.
For client requests, these fields are ignored. The HTTP
client code always uses either HTTP/1.1 or HTTP/2.
See the docs on Transport for details. // "HTTP/1.0" // 1 // 0 RemoteAddr allows HTTP servers and other software to record
the network address that sent the request, usually for
logging. This field is not filled in by ReadRequest and
has no defined format. The HTTP server in this package
sets RemoteAddr to an "IP:port" address before invoking a
handler.
This field is ignored by the HTTP client. RequestURI is the unmodified request-target of the
Request-Line (RFC 7230, Section 3.1.1) as sent by the client
to a server. Usually the URL field should be used instead.
It is an error to set this field in an HTTP client request. Response is the redirect response which caused this request
to be created. This field is only populated during client
redirects. TLS allows HTTP servers and other software to record
information about the TLS connection on which the request
was received. This field is not filled in by ReadRequest.
The HTTP server in this package sets the field for
TLS-enabled connections before invoking a handler;
otherwise it leaves the field nil.
This field is ignored by the HTTP client. Trailer specifies additional headers that are sent after the request
body.
For server requests, the Trailer map initially contains only the
trailer keys, with nil values. (The client declares which trailers it
will later send.) While the handler is reading from Body, it must
not reference Trailer. After reading from Body returns EOF, Trailer
can be read again and will contain non-nil values, if they were sent
by the client.
For client requests, Trailer must be initialized to a map containing
the trailer keys to later send. The values may be nil or their final
values. The ContentLength must be 0 or -1, to send a chunked request.
After the HTTP request is sent the map values can be updated while
the request body is read. Once the body returns EOF, the caller must
not mutate Trailer.
Few HTTP clients, servers, or proxies support HTTP trailers. TransferEncoding lists the transfer encodings from outermost to
innermost. An empty list denotes the "identity" encoding.
TransferEncoding can usually be ignored; chunked encoding is
automatically added and removed as necessary when sending and
receiving requests. URL specifies either the URI being requested (for server
requests) or the URL to access (for client requests).
For server requests, the URL is parsed from the URI
supplied on the Request-Line as stored in RequestURI. For
most requests, fields other than Path and RawQuery will be
empty. (See RFC 7230, Section 5.3)
For client requests, the URL's Host specifies the server to
connect to, while the Request's Host field optionally
specifies the Host header value to send in the HTTP
request. AddCookie adds a cookie to the request. Per RFC 6265 section 5.4,
AddCookie does not attach more than one [Cookie] header field. That
means all cookies, if any, are written into the same line,
separated by semicolon.
AddCookie only sanitizes c's name and value, and does not sanitize
a Cookie header already present in the request. BasicAuth returns the username and password provided in the request's
Authorization header, if the request uses HTTP Basic Authentication.
See RFC 2617, Section 2. Clone returns a deep copy of r with its context changed to ctx.
The provided ctx must be non-nil.
Clone only makes a shallow copy of the Body field.
For an outgoing client request, the context controls the entire
lifetime of a request and its response: obtaining a connection,
sending the request, and reading the response headers and body. Context returns the request's context. To change the context, use
[Request.Clone] or [Request.WithContext].
The returned context is always non-nil; it defaults to the
background context.
For outgoing client requests, the context controls cancellation.
For incoming server requests, the context is canceled when the
client's connection closes, the request is canceled (with HTTP/2),
or when the ServeHTTP method returns. Cookie returns the named cookie provided in the request or
[ErrNoCookie] if not found.
If multiple cookies match the given name, only one cookie will
be returned. Cookies parses and returns the HTTP cookies sent with the request. CookiesNamed parses and returns the named HTTP cookies sent with the request
or an empty slice if none matched. FormFile returns the first file for the provided form key.
FormFile calls [Request.ParseMultipartForm] and [Request.ParseForm] if necessary. FormValue returns the first value for the named component of the query.
The precedence order:
1. application/x-www-form-urlencoded form body (POST, PUT, PATCH only)
2. query parameters (always)
3. multipart/form-data form body (always)
FormValue calls [Request.ParseMultipartForm] and [Request.ParseForm]
if necessary and ignores any errors returned by these functions.
If key is not present, FormValue returns the empty string.
To access multiple values of the same key, call ParseForm and
then inspect [Request.Form] directly. MultipartReader returns a MIME multipart reader if this is a
multipart/form-data or a multipart/mixed POST request, else returns nil and an error.
Use this function instead of [Request.ParseMultipartForm] to
process the request body as a stream. ParseForm populates r.Form and r.PostForm.
For all requests, ParseForm parses the raw query from the URL and updates
r.Form.
For POST, PUT, and PATCH requests, it also reads the request body, parses it
as a form and puts the results into both r.PostForm and r.Form. Request body
parameters take precedence over URL query string values in r.Form.
If the request Body's size has not already been limited by [MaxBytesReader],
the size is capped at 10MB.
For other HTTP methods, or when the Content-Type is not
application/x-www-form-urlencoded, the request Body is not read, and
r.PostForm is initialized to a non-nil, empty value.
[Request.ParseMultipartForm] calls ParseForm automatically.
ParseForm is idempotent. ParseMultipartForm parses a request body as multipart/form-data.
The whole request body is parsed and up to a total of maxMemory bytes of
its file parts are stored in memory, with the remainder stored on
disk in temporary files.
ParseMultipartForm calls [Request.ParseForm] if necessary.
If ParseForm returns an error, ParseMultipartForm returns it but also
continues parsing the request body.
After one call to ParseMultipartForm, subsequent calls have no effect. PathValue returns the value for the named path wildcard in the [ServeMux] pattern
that matched the request.
It returns the empty string if the request was not matched against a pattern
or there is no such wildcard in the pattern. PostFormValue returns the first value for the named component of the POST,
PUT, or PATCH request body. URL query parameters are ignored.
PostFormValue calls [Request.ParseMultipartForm] and [Request.ParseForm] if necessary and ignores
any errors returned by these functions.
If key is not present, PostFormValue returns the empty string. ProtoAtLeast reports whether the HTTP protocol used
in the request is at least major.minor. Referer returns the referring URL, if sent in the request.
Referer is misspelled as in the request itself, a mistake from the
earliest days of HTTP. This value can also be fetched from the
[Header] map as Header["Referer"]; the benefit of making it available
as a method is that the compiler can diagnose programs that use the
alternate (correct English) spelling req.Referrer() but cannot
diagnose programs that use Header["Referrer"]. SetBasicAuth sets the request's Authorization header to use HTTP
Basic Authentication with the provided username and password.
With HTTP Basic Authentication the provided username and password
are not encrypted. It should generally only be used in an HTTPS
request.
The username may not contain a colon. Some protocols may impose
additional requirements on pre-escaping the username and
password. For instance, when used with OAuth2, both arguments must
be URL encoded first with [url.QueryEscape]. SetPathValue sets name to value, so that subsequent calls to r.PathValue(name)
return value. UserAgent returns the client's User-Agent, if sent in the request. WithContext returns a shallow copy of r with its context changed
to ctx. The provided ctx must be non-nil.
For outgoing client request, the context controls the entire
lifetime of a request and its response: obtaining a connection,
sending the request, and reading the response headers and body.
To create a new request with a context, use [NewRequestWithContext].
To make a deep copy of a request with a new context, use [Request.Clone]. Write writes an HTTP/1.1 request, which is the header and body, in wire format.
This method consults the following fields of the request:
Host
URL
Method (defaults to "GET")
Header
ContentLength
TransferEncoding
Body
If Body is present, Content-Length is <= 0 and [Request.TransferEncoding]
hasn't been set to "identity", Write adds "Transfer-Encoding:
chunked" to the header. Body is closed after it is sent. WriteProxy is like [Request.Write] but writes the request in the form
expected by an HTTP proxy. In particular, [Request.WriteProxy] writes the
initial Request-URI line of the request with an absolute URI, per
section 5.3 of RFC 7230, including the scheme and host.
In either case, WriteProxy also writes a Host header, using
either r.Host or r.URL.Host.
func NewRequest(method, url string, body io.Reader) (*Request, error)
func NewRequestWithContext(ctx context.Context, method, url string, body io.Reader) (*Request, error)
func ReadRequest(b *bufio.Reader) (*Request, error)
func (*Request).Clone(ctx context.Context) *Request
func (*Request).WithContext(ctx context.Context) *Request
func net/http/cgi.Request() (*Request, error)
func net/http/cgi.RequestFromMap(params map[string]string) (*Request, error)
func net/http/httptest.NewRequest(method, target string, body io.Reader) *Request
func net/http/httptest.NewRequestWithContext(ctx context.Context, method, target string, body io.Reader) *Request
func net/http/httputil.(*ServerConn).Read() (*Request, error)
func NotFound(w ResponseWriter, r *Request)
func ProxyFromEnvironment(req *Request) (*url.URL, error)
func ReadResponse(r *bufio.Reader, req *Request) (*Response, error)
func Redirect(w ResponseWriter, r *Request, url string, code int)
func ServeContent(w ResponseWriter, req *Request, name string, modtime time.Time, content io.ReadSeeker)
func ServeFile(w ResponseWriter, r *Request, name string)
func ServeFileFS(w ResponseWriter, r *Request, fsys fs.FS, name string)
func (*Client).Do(req *Request) (*Response, error)
func Handler.ServeHTTP(ResponseWriter, *Request)
func HandlerFunc.ServeHTTP(w ResponseWriter, r *Request)
func RoundTripper.RoundTrip(*Request) (*Response, error)
func (*ServeMux).Handler(r *Request) (h Handler, pattern string)
func (*ServeMux).ServeHTTP(w ResponseWriter, r *Request)
func (*Transport).CancelRequest(req *Request)
func (*Transport).RoundTrip(req *Request) (*Response, error)
func net/http/cgi.(*Handler).ServeHTTP(rw ResponseWriter, req *Request)
func net/http/fcgi.ProcessEnv(r *Request) map[string]string
func net/http/httputil.DumpRequest(req *Request, body bool) ([]byte, error)
func net/http/httputil.DumpRequestOut(req *Request, body bool) ([]byte, error)
func net/http/httputil.(*ClientConn).Do(req *Request) (*Response, error)
func net/http/httputil.(*ClientConn).Read(req *Request) (resp *Response, err error)
func net/http/httputil.(*ClientConn).Write(req *Request) error
func net/http/httputil.(*ReverseProxy).ServeHTTP(rw ResponseWriter, req *Request)
func net/http/httputil.(*ServerConn).Write(req *Request, resp *Response) error
func net/http/pprof.Cmdline(w ResponseWriter, r *Request)
func net/http/pprof.Index(w ResponseWriter, r *Request)
func net/http/pprof.Profile(w ResponseWriter, r *Request)
func net/http/pprof.Symbol(w ResponseWriter, r *Request)
func net/http/pprof.Trace(w ResponseWriter, r *Request)
func net/rpc.(*Server).ServeHTTP(w ResponseWriter, req *Request)
Response represents the response from an HTTP request.
The [Client] and [Transport] return Responses from servers once
the response headers have been received. The response body
is streamed on demand as the Body field is read. Body represents the response body.
The response body is streamed on demand as the Body field
is read. If the network connection fails or the server
terminates the response, Body.Read calls return an error.
The http Client and Transport guarantee that Body is always
non-nil, even on responses without a body or responses with
a zero-length body. It is the caller's responsibility to
close Body. The default HTTP client's Transport may not
reuse HTTP/1.x "keep-alive" TCP connections if the Body is
not read to completion and closed.
The Body is automatically dechunked if the server replied
with a "chunked" Transfer-Encoding.
As of Go 1.12, the Body will also implement io.Writer
on a successful "101 Switching Protocols" response,
as used by WebSockets and HTTP/2's "h2c" mode. Close records whether the header directed that the connection be
closed after reading Body. The value is advice for clients: neither
ReadResponse nor Response.Write ever closes a connection. ContentLength records the length of the associated content. The
value -1 indicates that the length is unknown. Unless Request.Method
is "HEAD", values >= 0 indicate that the given number of bytes may
be read from Body. Header maps header keys to values. If the response had multiple
headers with the same key, they may be concatenated, with comma
delimiters. (RFC 7230, section 3.2.2 requires that multiple headers
be semantically equivalent to a comma-delimited sequence.) When
Header values are duplicated by other fields in this struct (e.g.,
ContentLength, TransferEncoding, Trailer), the field values are
authoritative.
Keys in the map are canonicalized (see CanonicalHeaderKey). // e.g. "HTTP/1.0" // e.g. 1 // e.g. 0 Request is the request that was sent to obtain this Response.
Request's Body is nil (having already been consumed).
This is only populated for Client requests. // e.g. "200 OK" // e.g. 200 TLS contains information about the TLS connection on which the
response was received. It is nil for unencrypted responses.
The pointer is shared between responses and should not be
modified. Trailer maps trailer keys to values in the same
format as Header.
The Trailer initially contains only nil values, one for
each key specified in the server's "Trailer" header
value. Those values are not added to Header.
Trailer must not be accessed concurrently with Read calls
on the Body.
After Body.Read has returned io.EOF, Trailer will contain
any trailer values sent by the server. Contains transfer encodings from outer-most to inner-most. Value is
nil, means that "identity" encoding is used. Uncompressed reports whether the response was sent compressed but
was decompressed by the http package. When true, reading from
Body yields the uncompressed content instead of the compressed
content actually set from the server, ContentLength is set to -1,
and the "Content-Length" and "Content-Encoding" fields are deleted
from the responseHeader. To get the original response from
the server, set Transport.DisableCompression to true. Cookies parses and returns the cookies set in the Set-Cookie headers. Location returns the URL of the response's "Location" header,
if present. Relative redirects are resolved relative to
[Response.Request]. [ErrNoLocation] is returned if no
Location header is present. ProtoAtLeast reports whether the HTTP protocol used
in the response is at least major.minor. Write writes r to w in the HTTP/1.x server response format,
including the status line, headers, body, and optional trailer.
This method consults the following fields of the response r:
StatusCode
ProtoMajor
ProtoMinor
Request.Method
TransferEncoding
Trailer
Body
ContentLength
Header, values for non-canonical keys will have unpredictable behavior
The Response Body is closed after it is sent.
func Get(url string) (resp *Response, err error)
func Head(url string) (resp *Response, err error)
func Post(url, contentType string, body io.Reader) (resp *Response, err error)
func PostForm(url string, data url.Values) (resp *Response, err error)
func ReadResponse(r *bufio.Reader, req *Request) (*Response, error)
func (*Client).Do(req *Request) (*Response, error)
func (*Client).Get(url string) (resp *Response, err error)
func (*Client).Head(url string) (resp *Response, err error)
func (*Client).Post(url, contentType string, body io.Reader) (resp *Response, err error)
func (*Client).PostForm(url string, data url.Values) (resp *Response, err error)
func RoundTripper.RoundTrip(*Request) (*Response, error)
func (*Transport).RoundTrip(req *Request) (*Response, error)
func net/http/httptest.(*ResponseRecorder).Result() *Response
func net/http/httputil.(*ClientConn).Do(req *Request) (*Response, error)
func net/http/httputil.(*ClientConn).Read(req *Request) (resp *Response, err error)
func net/http/httputil.DumpResponse(resp *Response, body bool) ([]byte, error)
func net/http/httputil.(*ServerConn).Write(req *Request, resp *Response) error
A ResponseController is used by an HTTP handler to control the response.
A ResponseController may not be used after the [Handler.ServeHTTP] method has returned. EnableFullDuplex indicates that the request handler will interleave reads from [Request.Body]
with writes to the [ResponseWriter].
For HTTP/1 requests, the Go HTTP server by default consumes any unread portion of
the request body before beginning to write the response, preventing handlers from
concurrently reading from the request and writing the response.
Calling EnableFullDuplex disables this behavior and permits handlers to continue to read
from the request while concurrently writing the response.
For HTTP/2 requests, the Go HTTP server always permits concurrent reads and responses. Flush flushes buffered data to the client. Hijack lets the caller take over the connection.
See the Hijacker interface for details. SetReadDeadline sets the deadline for reading the entire request, including the body.
Reads from the request body after the deadline has been exceeded will return an error.
A zero value means no deadline.
Setting the read deadline after it has been exceeded will not extend it. SetWriteDeadline sets the deadline for writing the response.
Writes to the response body after the deadline has been exceeded will not block,
but may succeed if the data has been buffered.
A zero value means no deadline.
Setting the write deadline after it has been exceeded will not extend it.
*ResponseController : Hijacker
func NewResponseController(rw ResponseWriter) *ResponseController
A ResponseWriter interface is used by an HTTP handler to
construct an HTTP response.
A ResponseWriter may not be used after [Handler.ServeHTTP] has returned. Header returns the header map that will be sent by
[ResponseWriter.WriteHeader]. The [Header] map also is the mechanism with which
[Handler] implementations can set HTTP trailers.
Changing the header map after a call to [ResponseWriter.WriteHeader] (or
[ResponseWriter.Write]) has no effect unless the HTTP status code was of the
1xx class or the modified headers are trailers.
There are two ways to set Trailers. The preferred way is to
predeclare in the headers which trailers you will later
send by setting the "Trailer" header to the names of the
trailer keys which will come later. In this case, those
keys of the Header map are treated as if they were
trailers. See the example. The second way, for trailer
keys not known to the [Handler] until after the first [ResponseWriter.Write],
is to prefix the [Header] map keys with the [TrailerPrefix]
constant value.
To suppress automatic response headers (such as "Date"), set
their value to nil. Write writes the data to the connection as part of an HTTP reply.
If [ResponseWriter.WriteHeader] has not yet been called, Write calls
WriteHeader(http.StatusOK) before writing the data. If the Header
does not contain a Content-Type line, Write adds a Content-Type set
to the result of passing the initial 512 bytes of written data to
[DetectContentType]. Additionally, if the total size of all written
data is under a few KB and there are no Flush calls, the
Content-Length header is added automatically.
Depending on the HTTP protocol version and the client, calling
Write or WriteHeader may prevent future reads on the
Request.Body. For HTTP/1.x requests, handlers should read any
needed request body data before writing the response. Once the
headers have been flushed (due to either an explicit Flusher.Flush
call or writing enough data to trigger a flush), the request body
may be unavailable. For HTTP/2 requests, the Go HTTP server permits
handlers to continue to read the request body while concurrently
writing the response. However, such behavior may not be supported
by all HTTP/2 clients. Handlers should read before writing if
possible to maximize compatibility. WriteHeader sends an HTTP response header with the provided
status code.
If WriteHeader is not called explicitly, the first call to Write
will trigger an implicit WriteHeader(http.StatusOK).
Thus explicit calls to WriteHeader are mainly used to
send error codes or 1xx informational responses.
The provided code must be a valid HTTP 1xx-5xx status code.
Any number of 1xx headers may be written, followed by at most
one 2xx-5xx header. 1xx headers are sent immediately, but 2xx-5xx
headers may be buffered. Use the Flusher interface to send
buffered data. The header map is cleared when 2xx-5xx headers are
sent, but not with 1xx headers.
The server will automatically send a 100 (Continue) header
on the first read from the request body if the request has
an "Expect: 100-continue" header.
*net/http/httptest.ResponseRecorder
ResponseWriter : internal/bisect.Writer
ResponseWriter : io.Writer
func Error(w ResponseWriter, error string, code int)
func MaxBytesReader(w ResponseWriter, r io.ReadCloser, n int64) io.ReadCloser
func NewResponseController(rw ResponseWriter) *ResponseController
func NotFound(w ResponseWriter, r *Request)
func Redirect(w ResponseWriter, r *Request, url string, code int)
func ServeContent(w ResponseWriter, req *Request, name string, modtime time.Time, content io.ReadSeeker)
func ServeFile(w ResponseWriter, r *Request, name string)
func ServeFileFS(w ResponseWriter, r *Request, fsys fs.FS, name string)
func SetCookie(w ResponseWriter, cookie *Cookie)
func Handler.ServeHTTP(ResponseWriter, *Request)
func HandlerFunc.ServeHTTP(w ResponseWriter, r *Request)
func (*ServeMux).ServeHTTP(w ResponseWriter, r *Request)
func net/http/cgi.(*Handler).ServeHTTP(rw ResponseWriter, req *Request)
func net/http/httputil.(*ReverseProxy).ServeHTTP(rw ResponseWriter, req *Request)
func net/http/pprof.Cmdline(w ResponseWriter, r *Request)
func net/http/pprof.Index(w ResponseWriter, r *Request)
func net/http/pprof.Profile(w ResponseWriter, r *Request)
func net/http/pprof.Symbol(w ResponseWriter, r *Request)
func net/http/pprof.Trace(w ResponseWriter, r *Request)
func net/rpc.(*Server).ServeHTTP(w ResponseWriter, req *Request)
RoundTripper is an interface representing the ability to execute a
single HTTP transaction, obtaining the [Response] for a given [Request].
A RoundTripper must be safe for concurrent use by multiple
goroutines. RoundTrip executes a single HTTP transaction, returning
a Response for the provided Request.
RoundTrip should not attempt to interpret the response. In
particular, RoundTrip must return err == nil if it obtained
a response, regardless of the response's HTTP status code.
A non-nil err should be reserved for failure to obtain a
response. Similarly, RoundTrip should not attempt to
handle higher-level protocol details such as redirects,
authentication, or cookies.
RoundTrip should not modify the request, except for
consuming and closing the Request's Body. RoundTrip may
read fields of the request in a separate goroutine. Callers
should not mutate or reuse the request until the Response's
Body has been closed.
RoundTrip must always close the body, including on errors,
but depending on the implementation may do so in a separate
goroutine even after RoundTrip returns. This means that
callers wanting to reuse the body for subsequent requests
must arrange to wait for the Close call before doing so.
The Request's URL and Header fields must be initialized.
*Transport
func NewFileTransport(fs FileSystem) RoundTripper
func NewFileTransportFS(fsys fs.FS) RoundTripper
func (*Transport).RegisterProtocol(scheme string, rt RoundTripper)
var DefaultTransport
ServeMux is an HTTP request multiplexer.
It matches the URL of each incoming request against a list of registered
patterns and calls the handler for the pattern that
most closely matches the URL.
# Patterns
Patterns can match the method, host and path of a request.
Some examples:
- "/index.html" matches the path "/index.html" for any host and method.
- "GET /static/" matches a GET request whose path begins with "/static/".
- "example.com/" matches any request to the host "example.com".
- "example.com/{$}" matches requests with host "example.com" and path "/".
- "/b/{bucket}/o/{objectname...}" matches paths whose first segment is "b"
and whose third segment is "o". The name "bucket" denotes the second
segment and "objectname" denotes the remainder of the path.
In general, a pattern looks like
[METHOD ][HOST]/[PATH]
All three parts are optional; "/" is a valid pattern.
If METHOD is present, it must be followed by at least one space or tab.
Literal (that is, non-wildcard) parts of a pattern match
the corresponding parts of a request case-sensitively.
A pattern with no method matches every method. A pattern
with the method GET matches both GET and HEAD requests.
Otherwise, the method must match exactly.
A pattern with no host matches every host.
A pattern with a host matches URLs on that host only.
A path can include wildcard segments of the form {NAME} or {NAME...}.
For example, "/b/{bucket}/o/{objectname...}".
The wildcard name must be a valid Go identifier.
Wildcards must be full path segments: they must be preceded by a slash and followed by
either a slash or the end of the string.
For example, "/b_{bucket}" is not a valid pattern.
Normally a wildcard matches only a single path segment,
ending at the next literal slash (not %2F) in the request URL.
But if the "..." is present, then the wildcard matches the remainder of the URL path, including slashes.
(Therefore it is invalid for a "..." wildcard to appear anywhere but at the end of a pattern.)
The match for a wildcard can be obtained by calling [Request.PathValue] with the wildcard's name.
A trailing slash in a path acts as an anonymous "..." wildcard.
The special wildcard {$} matches only the end of the URL.
For example, the pattern "/{$}" matches only the path "/",
whereas the pattern "/" matches every path.
For matching, both pattern paths and incoming request paths are unescaped segment by segment.
So, for example, the path "/a%2Fb/100%25" is treated as having two segments, "a/b" and "100%".
The pattern "/a%2fb/" matches it, but the pattern "/a/b/" does not.
# Precedence
If two or more patterns match a request, then the most specific pattern takes precedence.
A pattern P1 is more specific than P2 if P1 matches a strict subset of P2’s requests;
that is, if P2 matches all the requests of P1 and more.
If neither is more specific, then the patterns conflict.
There is one exception to this rule, for backwards compatibility:
if two patterns would otherwise conflict and one has a host while the other does not,
then the pattern with the host takes precedence.
If a pattern passed to [ServeMux.Handle] or [ServeMux.HandleFunc] conflicts with
another pattern that is already registered, those functions panic.
As an example of the general rule, "/images/thumbnails/" is more specific than "/images/",
so both can be registered.
The former matches paths beginning with "/images/thumbnails/"
and the latter will match any other path in the "/images/" subtree.
As another example, consider the patterns "GET /" and "/index.html":
both match a GET request for "/index.html", but the former pattern
matches all other GET and HEAD requests, while the latter matches any
request for "/index.html" that uses a different method.
The patterns conflict.
# Trailing-slash redirection
Consider a [ServeMux] with a handler for a subtree, registered using a trailing slash or "..." wildcard.
If the ServeMux receives a request for the subtree root without a trailing slash,
it redirects the request by adding the trailing slash.
This behavior can be overridden with a separate registration for the path without
the trailing slash or "..." wildcard. For example, registering "/images/" causes ServeMux
to redirect a request for "/images" to "/images/", unless "/images" has
been registered separately.
# Request sanitizing
ServeMux also takes care of sanitizing the URL request path and the Host
header, stripping the port number and redirecting any request containing . or
.. segments or repeated slashes to an equivalent, cleaner URL.
# Compatibility
The pattern syntax and matching behavior of ServeMux changed significantly
in Go 1.22. To restore the old behavior, set the GODEBUG environment variable
to "httpmuxgo121=1". This setting is read once, at program startup; changes
during execution will be ignored.
The backwards-incompatible changes include:
- Wildcards are just ordinary literal path segments in 1.21.
For example, the pattern "/{x}" will match only that path in 1.21,
but will match any one-segment path in 1.22.
- In 1.21, no pattern was rejected, unless it was empty or conflicted with an existing pattern.
In 1.22, syntactically invalid patterns will cause [ServeMux.Handle] and [ServeMux.HandleFunc] to panic.
For example, in 1.21, the patterns "/{" and "/a{x}" match themselves,
but in 1.22 they are invalid and will cause a panic when registered.
- In 1.22, each segment of a pattern is unescaped; this was not done in 1.21.
For example, in 1.22 the pattern "/%61" matches the path "/a" ("%61" being the URL escape sequence for "a"),
but in 1.21 it would match only the path "/%2561" (where "%25" is the escape for the percent sign).
- When matching patterns to paths, in 1.22 each segment of the path is unescaped; in 1.21, the entire path is unescaped.
This change mostly affects how paths with %2F escapes adjacent to slashes are treated.
See https://go.dev/issue/21955 for details. Handle registers the handler for the given pattern.
If the given pattern conflicts, with one that is already registered, Handle
panics. HandleFunc registers the handler function for the given pattern.
If the given pattern conflicts, with one that is already registered, HandleFunc
panics. Handler returns the handler to use for the given request,
consulting r.Method, r.Host, and r.URL.Path. It always returns
a non-nil handler. If the path is not in its canonical form, the
handler will be an internally-generated handler that redirects
to the canonical path. If the host contains a port, it is ignored
when matching handlers.
The path and host are used unchanged for CONNECT requests.
Handler also returns the registered pattern that matches the
request or, in the case of internally-generated redirects,
the path that will match after following the redirect.
If there is no registered handler that applies to the request,
Handler returns a “page not found” handler and an empty pattern. ServeHTTP dispatches the request to the handler whose
pattern most closely matches the request URL.
*ServeMux : Handler
func NewServeMux() *ServeMux
var DefaultServeMux *ServeMux
A Server defines parameters for running an HTTP server.
The zero value for Server is a valid configuration. Addr optionally specifies the TCP address for the server to listen on,
in the form "host:port". If empty, ":http" (port 80) is used.
The service names are defined in RFC 6335 and assigned by IANA.
See net.Dial for details of the address format. BaseContext optionally specifies a function that returns
the base context for incoming requests on this server.
The provided Listener is the specific Listener that's
about to start accepting requests.
If BaseContext is nil, the default is context.Background().
If non-nil, it must return a non-nil context. ConnContext optionally specifies a function that modifies
the context used for a new connection c. The provided ctx
is derived from the base context and has a ServerContextKey
value. ConnState specifies an optional callback function that is
called when a client connection changes state. See the
ConnState type and associated constants for details. DisableGeneralOptionsHandler, if true, passes "OPTIONS *" requests to the Handler,
otherwise responds with 200 OK and Content-Length: 0. ErrorLog specifies an optional logger for errors accepting
connections, unexpected behavior from handlers, and
underlying FileSystem errors.
If nil, logging is done via the log package's standard logger. // handler to invoke, http.DefaultServeMux if nil IdleTimeout is the maximum amount of time to wait for the
next request when keep-alives are enabled. If zero, the value
of ReadTimeout is used. If negative, or if zero and ReadTimeout
is zero or negative, there is no timeout. MaxHeaderBytes controls the maximum number of bytes the
server will read parsing the request header's keys and
values, including the request line. It does not limit the
size of the request body.
If zero, DefaultMaxHeaderBytes is used. ReadHeaderTimeout is the amount of time allowed to read
request headers. The connection's read deadline is reset
after reading the headers and the Handler can decide what
is considered too slow for the body. If zero, the value of
ReadTimeout is used. If negative, or if zero and ReadTimeout
is zero or negative, there is no timeout. ReadTimeout is the maximum duration for reading the entire
request, including the body. A zero or negative value means
there will be no timeout.
Because ReadTimeout does not let Handlers make per-request
decisions on each request body's acceptable deadline or
upload rate, most users will prefer to use
ReadHeaderTimeout. It is valid to use them both. TLSConfig optionally provides a TLS configuration for use
by ServeTLS and ListenAndServeTLS. Note that this value is
cloned by ServeTLS and ListenAndServeTLS, so it's not
possible to modify the configuration with methods like
tls.Config.SetSessionTicketKeys. To use
SetSessionTicketKeys, use Server.Serve with a TLS Listener
instead. TLSNextProto optionally specifies a function to take over
ownership of the provided TLS connection when an ALPN
protocol upgrade has occurred. The map key is the protocol
name negotiated. The Handler argument should be used to
handle HTTP requests and will initialize the Request's TLS
and RemoteAddr if not already set. The connection is
automatically closed when the function returns.
If TLSNextProto is not nil, HTTP/2 support is not enabled
automatically. WriteTimeout is the maximum duration before timing out
writes of the response. It is reset whenever a new
request's header is read. Like ReadTimeout, it does not
let Handlers make decisions on a per-request basis.
A zero or negative value means there will be no timeout. Close immediately closes all active net.Listeners and any
connections in state [StateNew], [StateActive], or [StateIdle]. For a
graceful shutdown, use [Server.Shutdown].
Close does not attempt to close (and does not even know about)
any hijacked connections, such as WebSockets.
Close returns any error returned from closing the [Server]'s
underlying Listener(s). ListenAndServe listens on the TCP network address srv.Addr and then
calls [Serve] to handle requests on incoming connections.
Accepted connections are configured to enable TCP keep-alives.
If srv.Addr is blank, ":http" is used.
ListenAndServe always returns a non-nil error. After [Server.Shutdown] or [Server.Close],
the returned error is [ErrServerClosed]. ListenAndServeTLS listens on the TCP network address srv.Addr and
then calls [ServeTLS] to handle requests on incoming TLS connections.
Accepted connections are configured to enable TCP keep-alives.
Filenames containing a certificate and matching private key for the
server must be provided if neither the [Server]'s TLSConfig.Certificates
nor TLSConfig.GetCertificate are populated. If the certificate is
signed by a certificate authority, the certFile should be the
concatenation of the server's certificate, any intermediates, and
the CA's certificate.
If srv.Addr is blank, ":https" is used.
ListenAndServeTLS always returns a non-nil error. After [Server.Shutdown] or
[Server.Close], the returned error is [ErrServerClosed]. RegisterOnShutdown registers a function to call on [Server.Shutdown].
This can be used to gracefully shutdown connections that have
undergone ALPN protocol upgrade or that have been hijacked.
This function should start protocol-specific graceful shutdown,
but should not wait for shutdown to complete. Serve accepts incoming connections on the Listener l, creating a
new service goroutine for each. The service goroutines read requests and
then call srv.Handler to reply to them.
HTTP/2 support is only enabled if the Listener returns [*tls.Conn]
connections and they were configured with "h2" in the TLS
Config.NextProtos.
Serve always returns a non-nil error and closes l.
After [Server.Shutdown] or [Server.Close], the returned error is [ErrServerClosed]. ServeTLS accepts incoming connections on the Listener l, creating a
new service goroutine for each. The service goroutines perform TLS
setup and then read requests, calling srv.Handler to reply to them.
Files containing a certificate and matching private key for the
server must be provided if neither the [Server]'s
TLSConfig.Certificates, TLSConfig.GetCertificate nor
config.GetConfigForClient are populated.
If the certificate is signed by a certificate authority, the
certFile should be the concatenation of the server's certificate,
any intermediates, and the CA's certificate.
ServeTLS always returns a non-nil error. After [Server.Shutdown] or [Server.Close], the
returned error is [ErrServerClosed]. SetKeepAlivesEnabled controls whether HTTP keep-alives are enabled.
By default, keep-alives are always enabled. Only very
resource-constrained environments or servers in the process of
shutting down should disable them. Shutdown gracefully shuts down the server without interrupting any
active connections. Shutdown works by first closing all open
listeners, then closing all idle connections, and then waiting
indefinitely for connections to return to idle and then shut down.
If the provided context expires before the shutdown is complete,
Shutdown returns the context's error, otherwise it returns any
error returned from closing the [Server]'s underlying Listener(s).
When Shutdown is called, [Serve], [ListenAndServe], and
[ListenAndServeTLS] immediately return [ErrServerClosed]. Make sure the
program doesn't exit and waits instead for Shutdown to return.
Shutdown does not attempt to close nor wait for hijacked
connections such as WebSockets. The caller of Shutdown should
separately notify such long-lived connections of shutdown and wait
for them to close, if desired. See [Server.RegisterOnShutdown] for a way to
register shutdown notification functions.
Once Shutdown has been called on a server, it may not be reused;
future calls to methods such as Serve will return ErrServerClosed.
*Server : io.Closer
Transport is an implementation of [RoundTripper] that supports HTTP,
HTTPS, and HTTP proxies (for either HTTP or HTTPS with CONNECT).
By default, Transport caches connections for future re-use.
This may leave many open connections when accessing many hosts.
This behavior can be managed using [Transport.CloseIdleConnections] method
and the [Transport.MaxIdleConnsPerHost] and [Transport.DisableKeepAlives] fields.
Transports should be reused instead of created as needed.
Transports are safe for concurrent use by multiple goroutines.
A Transport is a low-level primitive for making HTTP and HTTPS requests.
For high-level functionality, such as cookies and redirects, see [Client].
Transport uses HTTP/1.1 for HTTP URLs and either HTTP/1.1 or HTTP/2
for HTTPS URLs, depending on whether the server supports HTTP/2,
and how the Transport is configured. The [DefaultTransport] supports HTTP/2.
To explicitly enable HTTP/2 on a transport, use golang.org/x/net/http2
and call ConfigureTransport. See the package docs for more about HTTP/2.
Responses with status codes in the 1xx range are either handled
automatically (100 expect-continue) or ignored. The one
exception is HTTP status code 101 (Switching Protocols), which is
considered a terminal status and returned by [Transport.RoundTrip]. To see the
ignored 1xx responses, use the httptrace trace package's
ClientTrace.Got1xxResponse.
Transport only retries a request upon encountering a network error
if the connection has been already been used successfully and if the
request is idempotent and either has no body or has its [Request.GetBody]
defined. HTTP requests are considered idempotent if they have HTTP methods
GET, HEAD, OPTIONS, or TRACE; or if their [Header] map contains an
"Idempotency-Key" or "X-Idempotency-Key" entry. If the idempotency key
value is a zero-length slice, the request is treated as idempotent but the
header is not sent on the wire. Dial specifies the dial function for creating unencrypted TCP connections.
Dial runs concurrently with calls to RoundTrip.
A RoundTrip call that initiates a dial may end up using
a connection dialed previously when the earlier connection
becomes idle before the later Dial completes.
Deprecated: Use DialContext instead, which allows the transport
to cancel dials as soon as they are no longer needed.
If both are set, DialContext takes priority. DialContext specifies the dial function for creating unencrypted TCP connections.
If DialContext is nil (and the deprecated Dial below is also nil),
then the transport dials using package net.
DialContext runs concurrently with calls to RoundTrip.
A RoundTrip call that initiates a dial may end up using
a connection dialed previously when the earlier connection
becomes idle before the later DialContext completes. DialTLS specifies an optional dial function for creating
TLS connections for non-proxied HTTPS requests.
Deprecated: Use DialTLSContext instead, which allows the transport
to cancel dials as soon as they are no longer needed.
If both are set, DialTLSContext takes priority. DialTLSContext specifies an optional dial function for creating
TLS connections for non-proxied HTTPS requests.
If DialTLSContext is nil (and the deprecated DialTLS below is also nil),
DialContext and TLSClientConfig are used.
If DialTLSContext is set, the Dial and DialContext hooks are not used for HTTPS
requests and the TLSClientConfig and TLSHandshakeTimeout
are ignored. The returned net.Conn is assumed to already be
past the TLS handshake. DisableCompression, if true, prevents the Transport from
requesting compression with an "Accept-Encoding: gzip"
request header when the Request contains no existing
Accept-Encoding value. If the Transport requests gzip on
its own and gets a gzipped response, it's transparently
decoded in the Response.Body. However, if the user
explicitly requested gzip it is not automatically
uncompressed. DisableKeepAlives, if true, disables HTTP keep-alives and
will only use the connection to the server for a single
HTTP request.
This is unrelated to the similarly named TCP keep-alives. ExpectContinueTimeout, if non-zero, specifies the amount of
time to wait for a server's first response headers after fully
writing the request headers if the request has an
"Expect: 100-continue" header. Zero means no timeout and
causes the body to be sent immediately, without
waiting for the server to approve.
This time does not include the time to send the request header. ForceAttemptHTTP2 controls whether HTTP/2 is enabled when a non-zero
Dial, DialTLS, or DialContext func or TLSClientConfig is provided.
By default, use of any those fields conservatively disables HTTP/2.
To use a custom dialer or TLS config and still attempt HTTP/2
upgrades, set this to true. GetProxyConnectHeader optionally specifies a func to return
headers to send to proxyURL during a CONNECT request to the
ip:port target.
If it returns an error, the Transport's RoundTrip fails with
that error. It can return (nil, nil) to not add headers.
If GetProxyConnectHeader is non-nil, ProxyConnectHeader is
ignored. IdleConnTimeout is the maximum amount of time an idle
(keep-alive) connection will remain idle before closing
itself.
Zero means no limit. MaxConnsPerHost optionally limits the total number of
connections per host, including connections in the dialing,
active, and idle states. On limit violation, dials will block.
Zero means no limit. MaxIdleConns controls the maximum number of idle (keep-alive)
connections across all hosts. Zero means no limit. MaxIdleConnsPerHost, if non-zero, controls the maximum idle
(keep-alive) connections to keep per-host. If zero,
DefaultMaxIdleConnsPerHost is used. MaxResponseHeaderBytes specifies a limit on how many
response bytes are allowed in the server's response
header.
Zero means to use a default limit. OnProxyConnectResponse is called when the Transport gets an HTTP response from
a proxy for a CONNECT request. It's called before the check for a 200 OK response.
If it returns an error, the request fails with that error. Proxy specifies a function to return a proxy for a given
Request. If the function returns a non-nil error, the
request is aborted with the provided error.
The proxy type is determined by the URL scheme. "http",
"https", "socks5", and "socks5h" are supported. If the scheme is empty,
"http" is assumed.
"socks5" is treated the same as "socks5h".
If the proxy URL contains a userinfo subcomponent,
the proxy request will pass the username and password
in a Proxy-Authorization header.
If Proxy is nil or returns a nil *URL, no proxy is used. ProxyConnectHeader optionally specifies headers to send to
proxies during CONNECT requests.
To set the header dynamically, see GetProxyConnectHeader. ReadBufferSize specifies the size of the read buffer used
when reading from the transport.
If zero, a default (currently 4KB) is used. ResponseHeaderTimeout, if non-zero, specifies the amount of
time to wait for a server's response headers after fully
writing the request (including its body, if any). This
time does not include the time to read the response body. TLSClientConfig specifies the TLS configuration to use with
tls.Client.
If nil, the default configuration is used.
If non-nil, HTTP/2 support may not be enabled by default. TLSHandshakeTimeout specifies the maximum amount of time to
wait for a TLS handshake. Zero means no timeout. TLSNextProto specifies how the Transport switches to an
alternate protocol (such as HTTP/2) after a TLS ALPN
protocol negotiation. If Transport dials a TLS connection
with a non-empty protocol name and TLSNextProto contains a
map entry for that key (such as "h2"), then the func is
called with the request's authority (such as "example.com"
or "example.com:1234") and the TLS connection. The function
must return a RoundTripper that then handles the request.
If TLSNextProto is not nil, HTTP/2 support is not enabled
automatically. WriteBufferSize specifies the size of the write buffer used
when writing to the transport.
If zero, a default (currently 4KB) is used. CancelRequest cancels an in-flight request by closing its connection.
CancelRequest should only be called after [Transport.RoundTrip] has returned.
Deprecated: Use [Request.WithContext] to create a request with a
cancelable context instead. CancelRequest cannot cancel HTTP/2
requests. This may become a no-op in a future release of Go. Clone returns a deep copy of t's exported fields. CloseIdleConnections closes any connections which were previously
connected from previous requests but are now sitting idle in
a "keep-alive" state. It does not interrupt any connections currently
in use. RegisterProtocol registers a new protocol with scheme.
The [Transport] will pass requests using the given scheme to rt.
It is rt's responsibility to simulate HTTP request semantics.
RegisterProtocol can be used by other packages to provide
implementations of protocol schemes like "ftp" or "file".
If rt.RoundTrip returns [ErrSkipAltProtocol], the Transport will
handle the [Transport.RoundTrip] itself for that one request, as if the
protocol were not registered. RoundTrip implements the [RoundTripper] interface.
For higher-level HTTP client support (such as handling of cookies
and redirects), see [Get], [Post], and the [Client] type.
Like the RoundTripper interface, the error types returned
by RoundTrip are unspecified.
*Transport : RoundTripper
func (*Transport).Clone() *Transport
Package-Level Functions (total 44)
AllowQuerySemicolons returns a handler that serves requests by converting any
unescaped semicolons in the URL query to ampersands, and invoking the handler h.
This restores the pre-Go 1.17 behavior of splitting query parameters on both
semicolons and ampersands. (See golang.org/issue/25192). Note that this
behavior doesn't match that of many proxies, and the mismatch can lead to
security issues.
AllowQuerySemicolons should be invoked before [Request.ParseForm] is called.
CanonicalHeaderKey returns the canonical format of the
header key s. The canonicalization converts the first
letter and any letter following a hyphen to upper case;
the rest are converted to lowercase. For example, the
canonical key for "accept-encoding" is "Accept-Encoding".
If s contains a space or invalid header field bytes, it is
returned without modifications.
DetectContentType implements the algorithm described
at https://mimesniff.spec.whatwg.org/ to determine the
Content-Type of the given data. It considers at most the
first 512 bytes of data. DetectContentType always returns
a valid MIME type: if it cannot determine a more specific one, it
returns "application/octet-stream".
Error replies to the request with the specified error message and HTTP code.
It does not otherwise end the request; the caller should ensure no further
writes are done to w.
The error message should be plain text.
Error deletes the Content-Length header,
sets Content-Type to “text/plain; charset=utf-8”,
and sets X-Content-Type-Options to “nosniff”.
This configures the header properly for the error message,
in case the caller had set it up expecting a successful output.
FileServer returns a handler that serves HTTP requests
with the contents of the file system rooted at root.
As a special case, the returned file server redirects any request
ending in "/index.html" to the same path, without the final
"index.html".
To use the operating system's file system implementation,
use [http.Dir]:
http.Handle("/", http.FileServer(http.Dir("/tmp")))
To use an [fs.FS] implementation, use [http.FileServerFS] instead.
FileServerFS returns a handler that serves HTTP requests
with the contents of the file system fsys.
The files provided by fsys must implement [io.Seeker].
As a special case, the returned file server redirects any request
ending in "/index.html" to the same path, without the final
"index.html".
http.Handle("/", http.FileServerFS(fsys))
Get issues a GET to the specified URL. If the response is one of
the following redirect codes, Get follows the redirect, up to a
maximum of 10 redirects:
301 (Moved Permanently)
302 (Found)
303 (See Other)
307 (Temporary Redirect)
308 (Permanent Redirect)
An error is returned if there were too many redirects or if there
was an HTTP protocol error. A non-2xx response doesn't cause an
error. Any returned error will be of type [*url.Error]. The url.Error
value's Timeout method will report true if the request timed out.
When err is nil, resp always contains a non-nil resp.Body.
Caller should close resp.Body when done reading from it.
Get is a wrapper around DefaultClient.Get.
To make a request with custom headers, use [NewRequest] and
DefaultClient.Do.
To make a request with a specified context.Context, use [NewRequestWithContext]
and DefaultClient.Do.
Handle registers the handler for the given pattern in [DefaultServeMux].
The documentation for [ServeMux] explains how patterns are matched.
HandleFunc registers the handler function for the given pattern in [DefaultServeMux].
The documentation for [ServeMux] explains how patterns are matched.
Head issues a HEAD to the specified URL. If the response is one of
the following redirect codes, Head follows the redirect, up to a
maximum of 10 redirects:
301 (Moved Permanently)
302 (Found)
303 (See Other)
307 (Temporary Redirect)
308 (Permanent Redirect)
Head is a wrapper around DefaultClient.Head.
To make a request with a specified [context.Context], use [NewRequestWithContext]
and DefaultClient.Do.
ListenAndServe listens on the TCP network address addr and then calls
[Serve] with handler to handle requests on incoming connections.
Accepted connections are configured to enable TCP keep-alives.
The handler is typically nil, in which case [DefaultServeMux] is used.
ListenAndServe always returns a non-nil error.
ListenAndServeTLS acts identically to [ListenAndServe], except that it
expects HTTPS connections. Additionally, files containing a certificate and
matching private key for the server must be provided. If the certificate
is signed by a certificate authority, the certFile should be the concatenation
of the server's certificate, any intermediates, and the CA's certificate.
MaxBytesReader is similar to [io.LimitReader] but is intended for
limiting the size of incoming request bodies. In contrast to
io.LimitReader, MaxBytesReader's result is a ReadCloser, returns a
non-nil error of type [*MaxBytesError] for a Read beyond the limit,
and closes the underlying reader when its Close method is called.
MaxBytesReader prevents clients from accidentally or maliciously
sending a large request and wasting server resources. If possible,
it tells the [ResponseWriter] to close the connection after the limit
has been reached.
NewFileTransport returns a new [RoundTripper], serving the provided
[FileSystem]. The returned RoundTripper ignores the URL host in its
incoming requests, as well as most other properties of the
request.
The typical use case for NewFileTransport is to register the "file"
protocol with a [Transport], as in:
t := &http.Transport{}
t.RegisterProtocol("file", http.NewFileTransport(http.Dir("/")))
c := &http.Client{Transport: t}
res, err := c.Get("file:///etc/passwd")
...
NewFileTransportFS returns a new [RoundTripper], serving the provided
file system fsys. The returned RoundTripper ignores the URL host in its
incoming requests, as well as most other properties of the
request. The files provided by fsys must implement [io.Seeker].
The typical use case for NewFileTransportFS is to register the "file"
protocol with a [Transport], as in:
fsys := os.DirFS("/")
t := &http.Transport{}
t.RegisterProtocol("file", http.NewFileTransportFS(fsys))
c := &http.Client{Transport: t}
res, err := c.Get("file:///etc/passwd")
...
NewRequestWithContext returns a new [Request] given a method, URL, and
optional body.
If the provided body is also an [io.Closer], the returned
[Request.Body] is set to body and will be closed (possibly
asynchronously) by the Client methods Do, Post, and PostForm,
and [Transport.RoundTrip].
NewRequestWithContext returns a Request suitable for use with
[Client.Do] or [Transport.RoundTrip]. To create a request for use with
testing a Server Handler, either use the [NewRequest] function in the
net/http/httptest package, use [ReadRequest], or manually update the
Request fields. For an outgoing client request, the context
controls the entire lifetime of a request and its response:
obtaining a connection, sending the request, and reading the
response headers and body. See the Request type's documentation for
the difference between inbound and outbound request fields.
If body is of type [*bytes.Buffer], [*bytes.Reader], or
[*strings.Reader], the returned request's ContentLength is set to its
exact value (instead of -1), GetBody is populated (so 307 and 308
redirects can replay the body), and Body is set to [NoBody] if the
ContentLength is 0.
NewResponseController creates a [ResponseController] for a request.
The ResponseWriter should be the original value passed to the [Handler.ServeHTTP] method,
or have an Unwrap method returning the original ResponseWriter.
If the ResponseWriter implements any of the following methods, the ResponseController
will call them as appropriate:
Flush()
FlushError() error // alternative Flush returning an error
Hijack() (net.Conn, *bufio.ReadWriter, error)
SetReadDeadline(deadline time.Time) error
SetWriteDeadline(deadline time.Time) error
EnableFullDuplex() error
If the ResponseWriter does not support a method, ResponseController returns
an error matching [ErrNotSupported].
NewServeMux allocates and returns a new [ServeMux].
NotFound replies to the request with an HTTP 404 not found error.
NotFoundHandler returns a simple request handler
that replies to each request with a “404 page not found” reply.
ParseCookie parses a Cookie header value and returns all the cookies
which were set in it. Since the same cookie name can appear multiple times
the returned Values can contain more than one value for a given key.
ParseHTTPVersion parses an HTTP version string according to RFC 7230, section 2.6.
"HTTP/1.0" returns (1, 0, true). Note that strings without
a minor version, such as "HTTP/2", are not valid.
ParseSetCookie parses a Set-Cookie header value and returns a cookie.
It returns an error on syntax error.
ParseTime parses a time header (such as the Date: header),
trying each of the three formats allowed by HTTP/1.1:
[TimeFormat], [time.RFC850], and [time.ANSIC].
Post issues a POST to the specified URL.
Caller should close resp.Body when done reading from it.
If the provided body is an [io.Closer], it is closed after the
request.
Post is a wrapper around DefaultClient.Post.
To set custom headers, use [NewRequest] and DefaultClient.Do.
See the [Client.Do] method documentation for details on how redirects
are handled.
To make a request with a specified context.Context, use [NewRequestWithContext]
and DefaultClient.Do.
PostForm issues a POST to the specified URL, with data's keys and
values URL-encoded as the request body.
The Content-Type header is set to application/x-www-form-urlencoded.
To set other headers, use [NewRequest] and DefaultClient.Do.
When err is nil, resp always contains a non-nil resp.Body.
Caller should close resp.Body when done reading from it.
PostForm is a wrapper around DefaultClient.PostForm.
See the [Client.Do] method documentation for details on how redirects
are handled.
To make a request with a specified [context.Context], use [NewRequestWithContext]
and DefaultClient.Do.
ProxyFromEnvironment returns the URL of the proxy to use for a
given request, as indicated by the environment variables
HTTP_PROXY, HTTPS_PROXY and NO_PROXY (or the lowercase versions
thereof). Requests use the proxy from the environment variable
matching their scheme, unless excluded by NO_PROXY.
The environment values may be either a complete URL or a
"host[:port]", in which case the "http" scheme is assumed.
An error is returned if the value is a different form.
A nil URL and nil error are returned if no proxy is defined in the
environment, or a proxy should not be used for the given request,
as defined by NO_PROXY.
As a special case, if req.URL.Host is "localhost" (with or without
a port number), then a nil URL and nil error will be returned.
ProxyURL returns a proxy function (for use in a [Transport])
that always returns the same URL.
ReadRequest reads and parses an incoming request from b.
ReadRequest is a low-level function and should only be used for
specialized applications; most code should use the [Server] to read
requests and handle them via the [Handler] interface. ReadRequest
only supports HTTP/1.x requests. For HTTP/2, use golang.org/x/net/http2.
ReadResponse reads and returns an HTTP response from r.
The req parameter optionally specifies the [Request] that corresponds
to this [Response]. If nil, a GET request is assumed.
Clients must call resp.Body.Close when finished reading resp.Body.
After that call, clients can inspect resp.Trailer to find key/value
pairs included in the response trailer.
Redirect replies to the request with a redirect to url,
which may be a path relative to the request path.
The provided code should be in the 3xx range and is usually
[StatusMovedPermanently], [StatusFound] or [StatusSeeOther].
If the Content-Type header has not been set, [Redirect] sets it
to "text/html; charset=utf-8" and writes a small HTML body.
Setting the Content-Type header to any value, including nil,
disables that behavior.
RedirectHandler returns a request handler that redirects
each request it receives to the given url using the given
status code.
The provided code should be in the 3xx range and is usually
[StatusMovedPermanently], [StatusFound] or [StatusSeeOther].
Serve accepts incoming HTTP connections on the listener l,
creating a new service goroutine for each. The service goroutines
read requests and then call handler to reply to them.
The handler is typically nil, in which case [DefaultServeMux] is used.
HTTP/2 support is only enabled if the Listener returns [*tls.Conn]
connections and they were configured with "h2" in the TLS
Config.NextProtos.
Serve always returns a non-nil error.
ServeContent replies to the request using the content in the
provided ReadSeeker. The main benefit of ServeContent over [io.Copy]
is that it handles Range requests properly, sets the MIME type, and
handles If-Match, If-Unmodified-Since, If-None-Match, If-Modified-Since,
and If-Range requests.
If the response's Content-Type header is not set, ServeContent
first tries to deduce the type from name's file extension and,
if that fails, falls back to reading the first block of the content
and passing it to [DetectContentType].
The name is otherwise unused; in particular it can be empty and is
never sent in the response.
If modtime is not the zero time or Unix epoch, ServeContent
includes it in a Last-Modified header in the response. If the
request includes an If-Modified-Since header, ServeContent uses
modtime to decide whether the content needs to be sent at all.
The content's Seek method must work: ServeContent uses
a seek to the end of the content to determine its size.
Note that [*os.File] implements the [io.ReadSeeker] interface.
If the caller has set w's ETag header formatted per RFC 7232, section 2.3,
ServeContent uses it to handle requests using If-Match, If-None-Match, or If-Range.
If an error occurs when serving the request (for example, when
handling an invalid range request), ServeContent responds with an
error message. By default, ServeContent strips the Cache-Control,
Content-Encoding, ETag, and Last-Modified headers from error responses.
The GODEBUG setting httpservecontentkeepheaders=1 causes ServeContent
to preserve these headers.
ServeFile replies to the request with the contents of the named
file or directory.
If the provided file or directory name is a relative path, it is
interpreted relative to the current directory and may ascend to
parent directories. If the provided name is constructed from user
input, it should be sanitized before calling [ServeFile].
As a precaution, ServeFile will reject requests where r.URL.Path
contains a ".." path element; this protects against callers who
might unsafely use [filepath.Join] on r.URL.Path without sanitizing
it and then use that filepath.Join result as the name argument.
As another special case, ServeFile redirects any request where r.URL.Path
ends in "/index.html" to the same path, without the final
"index.html". To avoid such redirects either modify the path or
use [ServeContent].
Outside of those two special cases, ServeFile does not use
r.URL.Path for selecting the file or directory to serve; only the
file or directory provided in the name argument is used.
ServeFileFS replies to the request with the contents
of the named file or directory from the file system fsys.
The files provided by fsys must implement [io.Seeker].
If the provided name is constructed from user input, it should be
sanitized before calling [ServeFileFS].
As a precaution, ServeFileFS will reject requests where r.URL.Path
contains a ".." path element; this protects against callers who
might unsafely use [filepath.Join] on r.URL.Path without sanitizing
it and then use that filepath.Join result as the name argument.
As another special case, ServeFileFS redirects any request where r.URL.Path
ends in "/index.html" to the same path, without the final
"index.html". To avoid such redirects either modify the path or
use [ServeContent].
Outside of those two special cases, ServeFileFS does not use
r.URL.Path for selecting the file or directory to serve; only the
file or directory provided in the name argument is used.
ServeTLS accepts incoming HTTPS connections on the listener l,
creating a new service goroutine for each. The service goroutines
read requests and then call handler to reply to them.
The handler is typically nil, in which case [DefaultServeMux] is used.
Additionally, files containing a certificate and matching private key
for the server must be provided. If the certificate is signed by a
certificate authority, the certFile should be the concatenation
of the server's certificate, any intermediates, and the CA's certificate.
ServeTLS always returns a non-nil error.
SetCookie adds a Set-Cookie header to the provided [ResponseWriter]'s headers.
The provided cookie must have a valid Name. Invalid cookies may be
silently dropped.
StatusText returns a text for the HTTP status code. It returns the empty
string if the code is unknown.
StripPrefix returns a handler that serves HTTP requests by removing the
given prefix from the request URL's Path (and RawPath if set) and invoking
the handler h. StripPrefix handles a request for a path that doesn't begin
with prefix by replying with an HTTP 404 not found error. The prefix must
match exactly: if the prefix in the request contains escaped characters
the reply is also an HTTP 404 not found error.
TimeoutHandler returns a [Handler] that runs h with the given time limit.
The new Handler calls h.ServeHTTP to handle each request, but if a
call runs for longer than its time limit, the handler responds with
a 503 Service Unavailable error and the given message in its body.
(If msg is empty, a suitable default message will be sent.)
After such a timeout, writes by h to its [ResponseWriter] will return
[ErrHandlerTimeout].
TimeoutHandler supports the [Pusher] interface but does not support
the [Hijacker] or [Flusher] interfaces.
DefaultTransport is the default implementation of [Transport] and is
used by [DefaultClient]. It establishes network connections as needed
and caches them for reuse by subsequent calls. It uses HTTP proxies
as directed by the environment variables HTTP_PROXY, HTTPS_PROXY
and NO_PROXY (or the lowercase versions thereof).
ErrAbortHandler is a sentinel panic value to abort a handler.
While any panic from ServeHTTP aborts the response to the client,
panicking with ErrAbortHandler also suppresses logging of a stack
trace to the server's error log.
ErrBodyNotAllowed is returned by ResponseWriter.Write calls
when the HTTP method or response code does not permit a
body.
ErrBodyReadAfterClose is returned when reading a [Request] or [Response]
Body after the body has been closed. This typically happens when the body is
read after an HTTP [Handler] calls WriteHeader or Write on its
[ResponseWriter].
ErrContentLength is returned by ResponseWriter.Write calls
when a Handler set a Content-Length response header with a
declared size and then attempted to write more bytes than
declared.
ErrHandlerTimeout is returned on [ResponseWriter] Write calls
in handlers which have timed out.
Deprecated: ErrHeaderTooLong is no longer returned by
anything in the net/http package. Callers should not
compare errors against this variable.
ErrHijacked is returned by ResponseWriter.Write calls when
the underlying connection has been hijacked using the
Hijacker interface. A zero-byte write on a hijacked
connection will return ErrHijacked without any other side
effects.
ErrLineTooLong is returned when reading request or response bodies
with malformed chunked encoding.
ErrMissingBoundary is returned by Request.MultipartReader when the
request's Content-Type does not include a "boundary" parameter.
Deprecated: ErrMissingContentLength is no longer returned by
anything in the net/http package. Callers should not
compare errors against this variable.
ErrMissingFile is returned by FormFile when the provided file field name
is either not present in the request or not a file field.
ErrNoCookie is returned by Request's Cookie method when a cookie is not found.
ErrNoLocation is returned by the [Response.Location] method
when no Location header is present.
ErrNotMultipart is returned by Request.MultipartReader when the
request's Content-Type is not multipart/form-data.
ErrNotSupported indicates that a feature is not supported.
It is returned by ResponseController methods to indicate that
the handler does not support the method, and by the Push method
of Pusher implementations to indicate that HTTP/2 Push support
is not available.
ErrSchemeMismatch is returned when a server returns an HTTP response to an HTTPS client.
Deprecated: ErrShortBody is no longer returned by
anything in the net/http package. Callers should not
compare errors against this variable.
ErrSkipAltProtocol is a sentinel error value defined by Transport.RegisterProtocol.
Deprecated: ErrUnexpectedTrailer is no longer returned by
anything in the net/http package. Callers should not
compare errors against this variable.
ErrUseLastResponse can be returned by Client.CheckRedirect hooks to
control how redirects are processed. If returned, the next request
is not sent and the most recent response is returned with its body
unclosed.
Deprecated: ErrWriteAfterFlush is no longer returned by
anything in the net/http package. Callers should not
compare errors against this variable.
LocalAddrContextKey is a context key. It can be used in
HTTP handlers with Context.Value to access the local
address the connection arrived on.
The associated value will be of type net.Addr.
NoBody is an [io.ReadCloser] with no bytes. Read always returns EOF
and Close always returns nil. It can be used in an outgoing client
request to explicitly signal that a request has zero bytes.
An alternative, however, is to simply set [Request.Body] to nil.
ServerContextKey is a context key. It can be used in HTTP
handlers with Context.Value to access the server that
started the handler. The associated value will be of
type *Server.
Package-Level Constants (total 84)
DefaultMaxHeaderBytes is the maximum permitted size of the headers
in an HTTP request.
This can be overridden by setting [Server.MaxHeaderBytes].
DefaultMaxIdleConnsPerHost is the default value of [Transport]'s
MaxIdleConnsPerHost.
Common HTTP methods.
Unless otherwise noted, these are defined in RFC 7231 section 4.3.
Common HTTP methods.
Unless otherwise noted, these are defined in RFC 7231 section 4.3.
Common HTTP methods.
Unless otherwise noted, these are defined in RFC 7231 section 4.3.
Common HTTP methods.
Unless otherwise noted, these are defined in RFC 7231 section 4.3.
Common HTTP methods.
Unless otherwise noted, these are defined in RFC 7231 section 4.3.
Common HTTP methods.
Unless otherwise noted, these are defined in RFC 7231 section 4.3.
Common HTTP methods.
Unless otherwise noted, these are defined in RFC 7231 section 4.3.
Common HTTP methods.
Unless otherwise noted, these are defined in RFC 7231 section 4.3.
Common HTTP methods.
Unless otherwise noted, these are defined in RFC 7231 section 4.3.
StateActive represents a connection that has read 1 or more
bytes of a request. The Server.ConnState hook for
StateActive fires before the request has entered a handler
and doesn't fire again until the request has been
handled. After the request is handled, the state
transitions to StateClosed, StateHijacked, or StateIdle.
For HTTP/2, StateActive fires on the transition from zero
to one active request, and only transitions away once all
active requests are complete. That means that ConnState
cannot be used to do per-request work; ConnState only notes
the overall state of the connection.
StateClosed represents a closed connection.
This is a terminal state. Hijacked connections do not
transition to StateClosed.
StateHijacked represents a hijacked connection.
This is a terminal state. It does not transition to StateClosed.
StateIdle represents a connection that has finished
handling a request and is in the keep-alive state, waiting
for a new request. Connections transition from StateIdle
to either StateActive or StateClosed.
StateNew represents a new connection that is expected to
send a request immediately. Connections begin at this
state and then transition to either StateActive or
StateClosed.
TimeFormat is the time format to use when generating times in HTTP
headers. It is like [time.RFC1123] but hard-codes GMT as the time
zone. The time being formatted must be in UTC for Format to
generate the correct format.
For parsing this time format, see [ParseTime].
TrailerPrefix is a magic prefix for [ResponseWriter.Header] map keys
that, if present, signals that the map entry is actually for
the response trailers, and not the response headers. The prefix
is stripped after the ServeHTTP call finishes and the values are
sent in the trailers.
This mechanism is intended only for trailers that are not known
prior to the headers being written. If the set of trailers is fixed
or known before the header is written, the normal Go trailers mechanism
is preferred:
https://pkg.go.dev/net/http#ResponseWriter
https://pkg.go.dev/net/http#example-ResponseWriter-Trailers
The pages are generated with Goldsv0.7.0-preview. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.