https://github.com/matryer/respond
Idiomatic API responses for Go.
https://github.com/matryer/respond
Last synced: 18 days ago
JSON representation
Idiomatic API responses for Go.
- Host: GitHub
- URL: https://github.com/matryer/respond
- Owner: matryer
- License: mit
- Created: 2015-03-23T11:21:59.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2021-12-14T19:30:57.000Z (over 3 years ago)
- Last Synced: 2025-03-24T15:11:14.792Z (about 1 month ago)
- Language: Go
- Homepage:
- Size: 314 KB
- Stars: 86
- Watchers: 2
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# respond [](https://godoc.org/github.com/matryer/respond)
* [v1](https://github.com/matryer/respond/releases/tag/v1) has been released
* Read the [blog post 'API responses in Go'](https://medium.com/@matryer/api-responses-in-go-1ef8f7b74997) for an in-depth overview
Get it:
```
go get gopkg.in/matryer/respond.v1
```
Import it:
```
import (
"gopkg.in/matryer/respond.v1"
)
```
Use it:
```
respond.With(w, r, http.StatusOK, data)
```
Package respond provides low-touch API responses for Go data services.
* Idiomatic way of responding to data APIs using `respond.With`
* Use `respond.With` to respond with default options, or make a `respond.Options` for [advanced features](https://godoc.org/github.com/matryer/respond#Options)
* Encoder abstraction lets you easily speak different formats
* `Before` and `After` function fields allow you to envelope and mutate data, set common HTTP headers, log activity etc.
* Protected against multiple responses
## Usage
The simplest use of `respond` is to just call `respond.With` inside your handlers:
```
func handleSomething(w http.ResponseWriter, r *http.Request) {
data, err := loadFromDB()
if err != nil {
// respond with an error
respond.With(w, r, http.StatusInternalServerError, err)
return // always return after responding
}
// respond with OK, and the data
respond.With(w, r, http.StatusOK, data)
}
```
To tweak the behaviour of `respond.With` you can wrap the handler with a `respond.Options`:
```
func main() {
opts := &respond.Options{
// options go here
}
http.Handle("/foo", opts.Handler(fooHandler))
log.Fatal(http.ListenAndServe(":8080", nil))
}
```
Use `respond.With` as normal.
For a complete list of options, see the [API documentation for respond.Options](https://godoc.org/github.com/matryer/respond#Options).