Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aliuygur/gores
Go package that handles HTML, JSON, XML and etc. responses
https://github.com/aliuygur/gores
go golang http-response json-api json-serialization rest-api restful
Last synced: 7 days ago
JSON representation
Go package that handles HTML, JSON, XML and etc. responses
- Host: GitHub
- URL: https://github.com/aliuygur/gores
- Owner: aliuygur
- License: apache-2.0
- Created: 2015-12-25T12:41:01.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-01-01T12:48:26.000Z (almost 4 years ago)
- Last Synced: 2024-05-29T21:30:03.059Z (4 months ago)
- Topics: go, golang, http-response, json-api, json-serialization, rest-api, restful
- Language: Go
- Homepage:
- Size: 25.4 KB
- Stars: 102
- Watchers: 6
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gores
[](https://travis-ci.org/alioygur/gores)
[](https://godoc.org/github.com/alioygur/gores)
[](https://goreportcard.com/report/github.com/alioygur/gores)
http response utility library for Go
this package is very small and lightweight, useful for RESTful APIs.
## installation
`go get github.com/alioygur/gores`
## requirements
gores library requires Go version `>=1.7`
## usage
```go
package main
import (
"log"
"net/http"
"github.com/alioygur/gores"
)
type User struct {
Name string
Email string
Age int
}
func main() {
// Plain text response
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
gores.String(w, http.StatusOK, "Hello World")
})
// HTML response
http.HandleFunc("/html", func(w http.ResponseWriter, r *http.Request) {
gores.HTML(w, http.StatusOK, "
Hello World
")
})
// JSON response
http.HandleFunc("/json", func(w http.ResponseWriter, r *http.Request) {
user := User{Name: "Ali", Email: "[email protected]", Age: 28}
gores.JSON(w, http.StatusOK, user)
})
// File response
http.HandleFunc("/file", func(w http.ResponseWriter, r *http.Request) {
err := gores.File(w, r, "./path/to/file.html")
if err != nil {
log.Println(err.Error())
}
})
// Download file
http.HandleFunc("/download-file", func(w http.ResponseWriter, r *http.Request) {
err := gores.Download(w, r, "./path/to/file.pdf", "example.pdf")
if err != nil {
log.Println(err.Error())
}
})
// No content
http.HandleFunc("/no-content", func(w http.ResponseWriter, r *http.Request) {
gores.NoContent(w)
})
// Error response
http.HandleFunc("/error", func(w http.ResponseWriter, r *http.Request) {
gores.Error(w, http.StatusInternalServerError, http.StatusText(http.StatusInternalServerError))
})
err := http.ListenAndServe(":8000", nil)
if err != nil {
log.Fatal("ListenAndServe: ", err)
}
}
```
for more documentation [godoc](https://godoc.org/github.com/alioygur/gores)
## Contribute
**Use issues for everything**
- Report problems
- Discuss before sending a pull request
- Suggest new features/recipes
- Improve/fix documentation
## Thanks & Authors
I use code/got inspiration from these excellent libraries:
- [labstack/echo](https://github.com/labstack/echo) micro web framework