resty -Go的简单HTTP和REST客户端，受Ruby rest-client启发

布满荆棘的人生 2023-07-06 11:41 1阅读 0赞

> go get -u gopkg.in/resty.v1

# News #

*  Resty v2开发正在进行中
 *  v1.12.0于2019年2月27日发布并标记。
 *  v1.11.0于2019年1月6日发布并标记。
 *  v1.10.3于2018年12月4日发布并标记。
 *  v1.0于2017年9月25日发布并标记。-Resty的第一个版本于2015年9月15日发布，后来逐渐发展成为一个非常方便和有用的库。从第一次发行到现在已经两年了。我非常感谢Resty用户及其贡献者。

# 功能 #

*  GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, 等

# 使用 #

以下示例将帮助您尽可能舒适地使用resty库。Resty附带了ready-to-use DefaultClient。

将resty导入到代码中并将其称为resty。

import "gopkg.in/resty.v1"

## get ##

// GET request
    resp, err := resty.R().Get("http://httpbin.org/get")
    
    // explore response object
    fmt.Printf("\nError: %v", err)
    fmt.Printf("\nResponse Status Code: %v", resp.StatusCode())
    fmt.Printf("\nResponse Status: %v", resp.Status())
    fmt.Printf("\nResponse Time: %v", resp.Time())
    fmt.Printf("\nResponse Received At: %v", resp.ReceivedAt())
    fmt.Printf("\nResponse Body: %v", resp)     // or resp.String() or string(resp.Body())
    // more...
    
    /* Output
    Error: <nil>
    Response Status Code: 200
    Response Status: 200 OK
    Response Time: 160.1151ms
    Response Received At: 2018-10-16 16:28:34.8595663 -0700 PDT m=+0.166119401
    Response Body: {
      "args": {},
      "headers": {
        "Accept-Encoding": "gzip",
        "Connection": "close",
        "Host": "httpbin.org",
        "User-Agent": "go-resty/1.10.0 (https://github.com/go-resty/resty)"
      },
      "origin": "0.0.0.0",
      "url": "http://httpbin.org/get"
    }
    */

resp, err := resty.R().
          SetQueryParams(map[string]string{
        
              "page_no": "1",
              "limit": "20",
              "sort":"name",
              "order": "asc",
              "random":strconv.FormatInt(time.Now().Unix(), 10),
          }).
          SetHeader("Accept", "application/json").
          SetAuthToken("BC594900518B4F7EAC75BD37F019E08FBC594900518B4F7EAC75BD37F019E08F").
          Get("/search_result")
    
    
    // Sample of using Request.SetQueryString method
    resp, err := resty.R().
          SetQueryString("productId=232&template=fresh-sample&cat=resty&source=google&kw=buy a lot more").
          SetHeader("Accept", "application/json").
          SetAuthToken("BC594900518B4F7EAC75BD37F019E08FBC594900518B4F7EAC75BD37F019E08F").
          Get("/show_product")

## POST方法 ##

// POST JSON string
    // No need to set content type, if you have client level setting
    resp, err := resty.R().
          SetHeader("Content-Type", "application/json").
          SetBody(`{"username":"testuser", "password":"testpass"}`).
          SetResult(&AuthSuccess{
        }).    // or SetResult(AuthSuccess{}).
          Post("https://myapp.com/login")
    
    // POST []byte array
    // No need to set content type, if you have client level setting
    resp, err := resty.R().
          SetHeader("Content-Type", "application/json").
          SetBody([]byte(`{"username":"testuser", "password":"testpass"}`)).
          SetResult(&AuthSuccess{
        }).    // or SetResult(AuthSuccess{}).
          Post("https://myapp.com/login")
    
    // POST Struct, default is JSON content type. No need to set one
    resp, err := resty.R().
          SetBody(User{
        Username: "testuser", Password: "testpass"}).
          SetResult(&AuthSuccess{
        }).    // or SetResult(AuthSuccess{}).
          SetError(&AuthError{
        }).       // or SetError(AuthError{}).
          Post("https://myapp.com/login")
    
    // POST Map, default is JSON content type. No need to set one
    resp, err := resty.R().
          SetBody(map[string]interface{
        }{
        "username": "testuser", "password": "testpass"}).
          SetResult(&AuthSuccess{
        }).    // or SetResult(AuthSuccess{}).
          SetError(&AuthError{
        }).       // or SetError(AuthError{}).
          Post("https://myapp.com/login")
    
    // POST of raw bytes for file upload. For example: upload file to Dropbox
    fileBytes, _ := ioutil.ReadFile("/Users/jeeva/mydocument.pdf")
    
    // See we are not setting content-type header, since go-resty automatically detects Content-Type for you
    resp, err := resty.R().
          SetBody(fileBytes).
          SetContentLength(true).          // Dropbox expects this value
          SetAuthToken("<your-auth-token>").
          SetError(&DropboxError{
        }).       // or SetError(DropboxError{}).
          Post("https://content.dropboxapi.com/1/files_put/auto/resty/mydocument.pdf") // for upload Dropbox supports PUT too
    
    // Note: resty detects Content-Type for request body/payload if content type header is not set.
    //   * For struct and map data type defaults to 'application/json'
    //   * Fallback is plain text content type

## put ##

// Note: This is one sample of PUT method usage, refer POST for more combination
    
    // Request goes as JSON content type
    // No need to set auth token, error, if you have client level settings
    resp, err := resty.R().
          SetBody(Article{
        
            Title: "go-resty",
            Content: "This is my article content, oh ya!",
            Author: "Jeevanandam M",
            Tags: []string{
        "article", "sample", "resty"},
          }).
          SetAuthToken("C6A79608-782F-4ED0-A11D-BD82FAD829CD").
          SetError(&Error{
        }).       // or SetError(Error{}).
          Put("https://myapp.com/article/1234")

## patch ##

// Note: This is one sample of PUT method usage, refer POST for more combination
    
    // Request goes as JSON content type
    // No need to set auth token, error, if you have client level settings
    resp, err := resty.R().
          SetBody(Article{
        
            Tags: []string{
        "new tag1", "new tag2"},
          }).
          SetAuthToken("C6A79608-782F-4ED0-A11D-BD82FAD829CD").
          SetError(&Error{
        }).       // or SetError(Error{}).
          Patch("https://myapp.com/articles/1234")

## delete、head、options ##

// DELETE a article
    // No need to set auth token, error, if you have client level settings
    resp, err := resty.R().
          SetAuthToken("C6A79608-782F-4ED0-A11D-BD82FAD829CD").
          SetError(&Error{
        }).       // or SetError(Error{}).
          Delete("https://myapp.com/articles/1234")
    
    // DELETE a articles with payload/body as a JSON string
    // No need to set auth token, error, if you have client level settings
    resp, err := resty.R().
          SetAuthToken("C6A79608-782F-4ED0-A11D-BD82FAD829CD").
          SetError(&Error{
        }).       // or SetError(Error{}).
          SetHeader("Content-Type", "application/json").
          SetBody(`{article_ids: [1002, 1006, 1007, 87683, 45432] }`).
          Delete("https://myapp.com/articles")
    
    // HEAD of resource
    // No need to set auth token, if you have client level settings
    resp, err := resty.R().
          SetAuthToken("C6A79608-782F-4ED0-A11D-BD82FAD829CD").
          Head("https://myapp.com/videos/hi-res-video")
    
    // OPTIONS of resource
    // No need to set auth token, if you have client level settings
    resp, err := resty.R().
          SetAuthToken("C6A79608-782F-4ED0-A11D-BD82FAD829CD").
          Options("https://myapp.com/servers/nyc-dc-01")

## 文件上传 ##

### 使用 io.Reader ###

profileImgBytes, _ := ioutil.ReadFile("/Users/jeeva/test-img.png")
    notesBytes, _ := ioutil.ReadFile("/Users/jeeva/text-file.txt")
    
    resp, err := resty.R().
          SetFileReader("profile_img", "test-img.png", bytes.NewReader(profileImgBytes)).
          SetFileReader("notes", "text-file.txt", bytes.NewReader(notesBytes)).
          SetFormData(map[string]string{
        
              "first_name": "Jeevanandam",
              "last_name": "M",
          }).
          Post("http://myapp.com/upload")

### 使用路径 ###

// Single file scenario
    resp, err := resty.R().
          SetFile("profile_img", "/Users/jeeva/test-img.png").
          Post("http://myapp.com/upload")
    
    // Multiple files scenario
    resp, err := resty.R().
          SetFiles(map[string]string{
        
            "profile_img": "/Users/jeeva/test-img.png",
            "notes": "/Users/jeeva/text-file.txt",
          }).
          Post("http://myapp.com/upload")
    
    // Multipart of form fields and files
    resp, err := resty.R().
          SetFiles(map[string]string{
        
            "profile_img": "/Users/jeeva/test-img.png",
            "notes": "/Users/jeeva/text-file.txt",
          }).
          SetFormData(map[string]string{
        
            "first_name": "Jeevanandam",
            "last_name": "M",
            "zip_code": "00001",
            "city": "my city",
            "access_token": "C6A79608-782F-4ED0-A11D-BD82FAD829CD",
          }).
          Post("http://myapp.com/profile")

## 表单提交 ##

// just mentioning about POST as an example with simple flow
    // User Login
    resp, err := resty.R().
          SetFormData(map[string]string{
        
            "username": "jeeva",
            "password": "mypass",
          }).
          Post("http://myapp.com/login")
    
    // Followed by profile update
    resp, err := resty.R().
          SetFormData(map[string]string{
        
            "first_name": "Jeevanandam",
            "last_name": "M",
            "zip_code": "00001",
            "city": "new city update",
          }).
          Post("http://myapp.com/profile")
    
    // Multi value form data
    criteria := url.Values{
        
      "search_criteria": []string{
        "book", "glass", "pencil"},
    }
    resp, err := resty.R().
          SetMultiValueFormData(criteria).
          Post("http://myapp.com/search")

## 将HTTP响应保存到文件中 ##

// Setting output directory path, If directory not exists then resty creates one!
    // This is optional one, if you're planning using absoule path in
    // `Request.SetOutput` and can used together.
    resty.SetOutputDirectory("/Users/jeeva/Downloads")
    
    // HTTP response gets saved into file, similar to curl -o flag
    _, err := resty.R().
              SetOutput("plugin/ReplyWithHeader-v5.1-beta.zip").
              Get("http://bit.ly/1LouEKr")
    
    // OR using absolute path
    // Note: output directory path is not used for absoulte path
    _, err := resty.R().
              SetOutput("/MyDownloads/plugin/ReplyWithHeader-v5.1-beta.zip").
              Get("http://bit.ly/1LouEKr")

# 请求URL路径参数 #

Resty提供了易于使用的动态请求URL路径参数。可以在客户端和请求级别设置参数。客户端级别的params值可以在请求级别重写。

resty.R().SetPathParams(map[string]string{
        
       "userId": "sample@sample.com",
       "subAccountId": "100002",
    }).
    Get("/v1/users/{userId}/{subAccountId}/details")
    
    // Result:
    //   Composed URL - /v1/users/sample@sample.com/100002/details