Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/srfrog/go-relax
Framework for building RESTful API's in Go
https://github.com/srfrog/go-relax
api-rest go golang microservices restful
Last synced: 3 months ago
JSON representation
Framework for building RESTful API's in Go
- Host: GitHub
- URL: https://github.com/srfrog/go-relax
- Owner: srfrog
- License: mit
- Created: 2014-06-26T02:30:45.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-07-12T23:09:48.000Z (over 1 year ago)
- Last Synced: 2024-03-22T12:22:39.829Z (8 months ago)
- Topics: api-rest, go, golang, microservices, restful
- Language: Go
- Homepage:
- Size: 214 KB
- Stars: 153
- Watchers: 11
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-rest - go-relax - Framework of pluggable components to build RESTful API's. (Servers / Go)
README
# Go-Relax [](https://pkg.go.dev/github.com/srfrog/go-relax) [](https://goreportcard.com/report/github.com/srfrog/go-relax)
*Build fast and complete RESTful APIs in [Go](http://golang.org)*
*Go-Relax* aims to provide the tools to help developers build RESTful web services, and information needed to abide by [REST](https://en.wikipedia.org/wiki/REST) architectural constraints using correct [HTTP semantics](http://tools.ietf.org/html/rfc7231).
## Quick Start
Install using "go get":
go get github.com/srfrog/go-relax
Then import from your source:
import "github.com/srfrog/go-relax"
View [example_test.go](https://github.com/srfrog/go-relax/blob/master/example/example_test.go) for an extended example of basic usage and features.
Also, check the [wiki](https://github.com/srfrog/go-relax/wiki) for HowTo's and recipes.
## Features
- Helps build API's that follow the REST concept using ROA principles.
- Built-in support of HATEOAS constraint with Web Linking header tags.
- Follows REST "best practices", with inspiration from Heroku and GitHub.
- Works fine along with ``http.ServeMux`` or independently as ``http.Handler``
- Supports different media types, and **mixed** for requests and responses.
- It uses **JSON** media type by default, but also includes XML (needs import).
- The default routing engine uses **trie with regexp matching** for speed and flexibility.
- Comes with a complete set of filters to build a working API. _"Batteries included"_
- Uses ``sync.pool`` to efficiently use resources when under heavy load.
#### Included filters
- [x] Content - handles mixed request/response encodings, language preference, and versioning.
- [x] Basic authentication - to protect any resource with passwords.
- [x] CORS - Cross-Origin Resource Sharing, for remote client-server setups.
- [x] ETag - entity tagging with conditional requests for efficient caching.
- [x] GZip - Dynamic gzip content data compression, with ETag support.
- [x] Logging - custom logging with pre- and post- request event support.
- [x] Method override - GET/POST method override via HTTP header and query string.
- [x] Security - Various security practices for request handling.
- [x] Limits - request throttler, token-based rate limiter, and memory limits.
#### Upcoming filters
- [ ] JSON-API support.
- [ ] JSON-Schema for validating requests and responses.
- [ ] Collection-JSON support.
## Documentation
The full code documentation is located at GoDoc:
[https://pkg.go.dev/github.com/srfrog/go-relax](https://pkg.go.dev/github.com/srfrog/go-relax)
The source code is thoroughly commented, have a look.
## Hello World
This minimal example creates a new Relax service that handles a Hello resource.
```go
package main
import (
"github.com/srfrog/go-relax"
)
type Hello string
func (h *Hello) Index(ctx *relax.Context) {
ctx.Respond(h)
}
func main() {
h := Hello("hello world!")
svc := relax.NewService("http://api.company.com/")
svc.Resource(&h)
svc.Run()
}
```
**$ curl -i -X GET http://api.company.com/hello**
Response:
```
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Link: ; rel="self"
Link: ; rel="index"
Request-Id: 61d430de-7bb6-4ff8-84da-aff6fe81c0d2
Server: Go-Relax/0.5.0
Date: Thu, 14 Aug 2014 06:20:48 GMT
Content-Length: 14
"hello world!"
```
## Credits
**Go-Relax** is Copyright (c) [Codehack](http://codehack.com).
Published under an [MIT License](https://raw.githubusercontent.com/srfrog/go-relax/master/LICENSE)