How to use Resty: a Go HTTP and REST client guide

What Resty is and when to use it

Resty is a code library, not a standalone application. You import it into a Go program to send web requests to other services, such as a REST API, or to receive server-sent events. The project describes itself as a simple HTTP, REST and SSE client library for Go.

It is a good fit for Go developers who call HTTP APIs and want a simpler client than the standard library's HTTP calls, or for projects that need SSE on the client side.

• Use it if: your project is written in Go and calls HTTP or REST APIs.
• Use it if: you need server-sent events on the client side.
• Skip it if: you are not a programmer, since it is a library rather than a ready-made app.
• Skip it if: your project is not written in Go, since it only works with Go.

Check the requirements before you install

Resty needs Go 1.23 or newer. The README states that go1.23 and above is required, so if your project must target an older Go version, Resty is not an option for it.

Resty is MIT licensed, and its documentation and website are released under Apache-2.0.

Install the Resty v3 module

Resty is installed as a Go module with the standard Go tooling. The README gives the command to install the v3 module. Run it in your project directory, where your Go module is set up.

Resty v3 is served from the vanity URL resty.dev/v3, so the import path you use in your code is based on that address.

Make your first request

Once the module is installed, import Resty in your Go code and use it to send requests to the service you want to call. For the exact client setup, request methods and SSE handling, follow the official documentation at https://resty.dev, which the README points to. It also refers to godoc for API details, available at pkg.go.dev/resty.dev/v3.

• Import resty.dev/v3 in the Go file that makes the request.
• Check the documentation at resty.dev for example usage of the client.
• Use pkg.go.dev/resty.dev/v3 to look up the API for the functions you call.

Choose between Resty, net/http and other clients

Resty wraps Go's standard net/http package in a simpler interface. If you prefer to use only the standard library, net/http is the built-in option and needs no extra dependency. Other comparable projects include go-resty/resty v2 and carlmjohnson/requests.

The README notes that v2 migrated to github.com/go-resty/resty/v2. Pick the version that matches your project and check its documentation before you start.

• net/http: Go's standard library, no third-party dependency.
• go-resty/resty v2: the earlier major version, imported from github.com/go-resty/resty/v2.
• carlmjohnson/requests: another HTTP client for Go.

Get help and contribute

Questions about usage are best directed to the documentation at resty.dev. The README invites feedback, real-world usage stories and discussion on GitHub Discussions. Contributions are welcome through pull requests, and the README says they must include test cases with patch coverage of 100%.

• Read the docs at https://resty.dev.
• Discuss usage on GitHub Discussions at github.com/go-resty/resty/discussions.
• Send pull requests for fixes or improvements, with tests.