blob: b1216e8dafa5b701a59cd4f167085d1bfcd8553e [file] [log] [blame]
Brad Fitzpatrick2b5aa282011-10-24 13:59:31 -07001// Copyright 2011 The Go Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
5/*
Brad Fitzpatrickd72267a2011-10-24 19:29:44 -07006Package http provides HTTP client and server implementations.
Brad Fitzpatrick2b5aa282011-10-24 13:59:31 -07007
Russ Cox1b0bffa2013-10-02 13:21:15 -04008Get, Head, Post, and PostForm make HTTP (or HTTPS) requests:
Brad Fitzpatrick2b5aa282011-10-24 13:59:31 -07009
10 resp, err := http.Get("http://example.com/")
11 ...
12 resp, err := http.Post("http://example.com/upload", "image/jpeg", &buf)
13 ...
14 resp, err := http.PostForm("http://example.com/form",
Brad Fitzpatrick3484d542012-02-09 14:10:36 +110015 url.Values{"key": {"Value"}, "id": {"123"}})
Brad Fitzpatrick2b5aa282011-10-24 13:59:31 -070016
17The client must close the response body when finished with it:
18
19 resp, err := http.Get("http://example.com/")
20 if err != nil {
21 // handle error
22 }
23 defer resp.Body.Close()
24 body, err := ioutil.ReadAll(resp.Body)
25 // ...
26
27For control over HTTP client headers, redirect policy, and other
28settings, create a Client:
29
30 client := &http.Client{
31 CheckRedirect: redirectPolicyFunc,
32 }
33
34 resp, err := client.Get("http://example.com")
35 // ...
36
Christoph Hack2a6b4e12012-01-19 06:11:02 -080037 req, err := http.NewRequest("GET", "http://example.com", nil)
38 // ...
Brad Fitzpatrick2b5aa282011-10-24 13:59:31 -070039 req.Header.Add("If-None-Match", `W/"wyzzy"`)
40 resp, err := client.Do(req)
41 // ...
42
43For control over proxies, TLS configuration, keep-alives,
44compression, and other settings, create a Transport:
45
46 tr := &http.Transport{
47 TLSClientConfig: &tls.Config{RootCAs: pool},
48 DisableCompression: true,
49 }
50 client := &http.Client{Transport: tr}
51 resp, err := client.Get("https://example.com")
52
53Clients and Transports are safe for concurrent use by multiple
54goroutines and for efficiency should only be created once and re-used.
55
56ListenAndServe starts an HTTP server with a given address and handler.
57The handler is usually nil, which means to use DefaultServeMux.
58Handle and HandleFunc add handlers to DefaultServeMux:
59
60 http.Handle("/foo", fooHandler)
61
62 http.HandleFunc("/bar", func(w http.ResponseWriter, r *http.Request) {
Bjorn Tipling0846e272012-02-10 22:39:57 -020063 fmt.Fprintf(w, "Hello, %q", html.EscapeString(r.URL.Path))
Brad Fitzpatrick2b5aa282011-10-24 13:59:31 -070064 })
65
66 log.Fatal(http.ListenAndServe(":8080", nil))
67
68More control over the server's behavior is available by creating a
69custom Server:
70
71 s := &http.Server{
72 Addr: ":8080",
73 Handler: myHandler,
David Symonds3dbecd52011-12-13 10:42:56 +110074 ReadTimeout: 10 * time.Second,
75 WriteTimeout: 10 * time.Second,
Brad Fitzpatrick2b5aa282011-10-24 13:59:31 -070076 MaxHeaderBytes: 1 << 20,
77 }
78 log.Fatal(s.ListenAndServe())
79*/
80package http