forked from rs/rest-layer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
30 lines (24 loc) · 1.46 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/*
Package rest_layer is a REST API framework heavily inspired by the excellent
Python Eve (http://python-eve.org).
It lets you automatically generate a comprehensive, customizable, and secure
REST API on top of any backend storage with no boiler plate code. You can focus
on your business logic now.
Implemented as a `net/http` middleware, it plays well with other middlewares like
CORS (http://github.com/rs/cors).
REST Layer is an opinionated framework. Unlike many web frameworks, you don't
directly control the routing. You just expose resources and sub-resources, the
framework automatically figures what routes to generate behind the scene.
You don't have to take care of the HTTP headers and response, JSON encoding, etc.
either. rest handles HTTP conditional requests, caching, integrity checking for
you. A powerful and extensible validation engine make sure that data comes
pre-validated to you resource handlers. Generic resource handlers for MongoDB and
other databases are also available so you have few to no code to write to make
the whole system work.
REST Layer is composed of several sub-packages:
- rest: Holds the `net/http` handler responsible for the implementation of the RESTful API.
- schema: Provides a validation framework for the API resources.
- resource: Defines resources, manages the resource graph and manages the interface with resource storage handler.
See http://github.com/rs/rest-layer for full REST Layer documentation.
*/
package rest_layer