Skip to content

restyvshttr

MIT 67 1 9,632
58.1 thousand (month) Oct 28 2018 v2.13.1(2 months ago)
982 9 2 MIT
May 06 2012 712.9 thousand (month) 1.4.7(1 year, 2 months ago)

Resty is an HTTP and REST client library for Go. It is designed to be simple and easy to use, while still providing a lot of powerful features. One of the main benefits of using Resty is that it allows you to make HTTP requests with minimal boilerplate code, while still providing a lot of flexibility and control over the requests.

One of the key features of Resty is its use of chaining. This allows you to chain together multiple methods to build up a request, making the code more readable and easy to understand. For example, you can chain together the R().SetHeader("Accept", "application/json") method to set the Accept header and R().SetQueryParam("param1", "value1") to add a query parameter to the request.

Resty also provides a lot of convenience functions for making common types of requests, such as Get, Post, Put, and Delete. This can be useful if you need to make a simple request quickly and don't want to spend a lot of time configuring the request. Additionally, Resty also provides a way to set a timeout for the request, in case the server takes too long to respond.

Resty also supports HTTP/2 and advanced features like multipart file upload, request and response middlewares, request hooks, and many others.

Overall, Resty is a good choice if you're looking for a simple and easy-to-use HTTP client library for Go. It's a good fit for projects that don't require a lot of customization and need a quick way to make HTTP requests.

The aim of httr is to provide a wrapper for the curl package, customised to the demands of modern web APIs.

Key features:

  • Functions for the most important http verbs: GET(), HEAD(), PATCH(), PUT(), DELETE() and POST().
  • Automatic connection sharing across requests to the same website (by default, curl handles are managed automatically), cookies are maintained across requests, and a up-to-date root-level SSL certificate store is used.
  • Requests return a standard reponse object that captures the http status line, headers and body, along with other useful information.
  • Response content is available with content() as a raw vector (as = "raw"), a character vector (as = "text"), or parsed into an R object (as = "parsed"), currently for html, xml, json, png and jpeg.
  • You can convert http errors into R errors with stop_for_status().
  • Config functions make it easier to modify the request in common ways: set_cookies(), add_headers(), authenticate(), use_proxy(), verbose(), timeout(), content_type(), accept(), progress().
  • Support for OAuth 1.0 and 2.0 with oauth1.0_token() and oauth2.0_token(). The demo directory has eight OAuth demos: four for 1.0 (twitter, vimeo, withings and yahoo) and four for 2.0 (facebook, github, google, linkedin). OAuth credentials are automatically cached within a project.

Example Use


package main

// establish session client
client := resty.New()
// set proxy for the session
client.SetProxy("http://proxyserver:8888")
// set retries
client.
    // Set retry count to non zero to enable retries
    SetRetryCount(3).
    // You can override initial retry wait time.
    // Default is 100 milliseconds.
    SetRetryWaitTime(5 * time.Second).
    // MaxWaitTime can be overridden as well.
    // Default is 2 seconds.
    SetRetryMaxWaitTime(20 * time.Second).
    // SetRetryAfter sets callback to calculate wait time between retries.
    // Default (nil) implies exponential backoff with jitter
    SetRetryAfter(func(client *resty.Client, resp *resty.Response) (time.Duration, error) {
        return 0, errors.New("quota exceeded")
    })

// Make GET request
resp, err := client.R().
    // we can set query
    SetQueryParams(map[string]string{
        "query": "foo",
    }).
    // and headers
    SetHeader("Accept", "application/json").
    Get("https://httpbin.org/get")

// Make Post request
resp, err := client.R().
    // JSON data
    SetHeader("Content-Type", "application/json").
    SetBody(`{"username":"testuser", "password":"testpass"}`).
    // or Form Data
    SetFormData(map[string]string{
      "username": "jeeva",
      "password": "mypass",
    }).
    Post("https://httpbin.org/post")

// resty also support request and response middlewares
// which allow easy modification of outgoing requests and incoming responses
client.OnBeforeRequest(func(c *resty.Client, req *resty.Request) error {
    // Now you have access to Client and current Request object
    // manipulate it as per your need

    return nil  // if its success otherwise return error
  })

// Registering Response Middleware
client.OnAfterResponse(func(c *resty.Client, resp *resty.Response) error {
    // Now you have access to Client and current Response object
    // manipulate it as per your need

    return nil  // if its success otherwise return error
  })
library(httr)

# GET requests:
resp <- GET("http://httpbin.org/get")
status_code(resp)  # status code
headers(resp)  # headers
str(content(resp))  # body

# POST requests: 
# Form encoded
resp <- POST(url, body = body, encode = "form")
# Multipart encoded
resp <- POST(url, body = body, encode = "multipart")
# JSON encoded
resp <- POST(url, body = body, encode = "json")

# setting cookies:
resp <- GET("http://httpbin.org/cookies", set_cookies("MeWant" = "cookies"))
content(r)$cookies  # get response cookies

Alternatives / Similar


Was this page helpful?