Luddite is a golang package that provides a micro-framework
for RESTful web services. It is built around extensible, pluggable
middleware layers and includes a standard Resource interface that
makes it easy to implement services that comply with the
Orion REST API Standards.
To run the example service:
$ cd example
$ go build .
$ ./example -c config.yaml
Two types of resources are provided:
- Singleton: Supports
GETandPUT. - Collection: Supports
GET,POST,PUT, andDELETE.
Resources may also implement POST actions and be made read-only.
Since luddite is a micro-framework, implementations retain
substantial flexibility.
Currently, the framework registers several middleware handlers for each service:
- Bottom: Combines CORS, tracing, logging, metrics, and recovery
actions. Tracing generates a unique request id and optionally
records traces to a persistent backend. Logging logs
requests/responses in a structured JSON format. Metrics
increments basic request/response stats. Recovery handles panics
that occur in HTTP method handlers and optionally includes stack
traces in 500 responses. Also makes the
Serviceinstance, request id, and response headers available to resource handlers as part of the request [context][context]. - Negotiation: Performs JSON (default) and XML content negotiation
based on HTTP requests'
Acceptheaders. - Version: Performs API version selection and enforces the service's min/max supported version constraints. Makes the selected API version available to resource handlers as part of the request [context][context]. [context]: http://blog.golang.org/context
Need to document these:
- Metrics
- Schema file serving
- TLS requirements
- Min/max versioning
