Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.01 KB

README.md

File metadata and controls

30 lines (19 loc) · 1.01 KB

A RESTful HTTP client and server.

Install by running:

goinstall github.com/nathankerr/rest.go

Checkout examples/snips/snips.go for a simple client and server example

rest.go uses the standard http package by adding resource routes. Add a new route by:

rest.Resource("resourcepath", resourcevariable)

and then use http as normal.

A resource is an object that may have any of the following methods which respond to the specified HTTP requests:

GET /resource/ => Index(http.ResponseWriter)
GET /resource/id => Find(http.ResponseWriter, id string)
POST /resource/ => Create(http.ResponseWriter, *http.Request)
PUT /resource/id => Update(http.ResponseWriter, id string, *http.Request)
DELETE /resource/id => Delete(http.ResponseWriter, id string)
OPTIONS /resource/ => Options(http.ResponseWriter, id string)
OPTIONS /resource/id => Options(http.ResponseWriter, id string)

The server will then route HTTP requests to the appropriate method call.

The snips example provides a full example of both a client and server.