Build fast and complete RESTful APIs in Go

Go-Relax aims to provide the tools to help developers build RESTful web services, and information needed to abide by REST architectural constraints using correct HTTP semantics.

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 for an extended example of basic usage and features.

Also, check the wiki for HowTo's and recipes.

• 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.

• Content - handles mixed request/response encodings, language preference, and versioning.
• Basic authentication - to protect any resource with passwords.
• CORS - Cross-Origin Resource Sharing, for remote client-server setups.
• ETag - entity tagging with conditional requests for efficient caching.
• GZip - Dynamic gzip content data compression, with ETag support.
• Logging - custom logging with pre- and post- request event support.
• Method override - GET/POST method override via HTTP header and query string.
• Security - Various security practices for request handling.
• Limits - request throttler, token-based rate limiter, and memory limits.

• JSON-API support.
• JSON-Schema for validating requests and responses.
• Collection-JSON support.

The full code documentation is located at GoDoc:

https://pkg.go.dev/github.com/srfrog/go-relax

The source code is thoroughly commented, have a look.

This minimal example creates a new Relax service that handles a Hello resource.

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.example.com/")
   svc.Resource(&h)
   svc.Run()
}

$ curl -i -X GET http://api.example.com/hello

Response:

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Link: </hello>; rel="self"
Link: </hello>; 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!"

Go-Relax is Copyright (c) CastleBytes. Published under an MIT License