gopencils

README

Gopencils - Dynamically consume REST APIs

Summary

Gopencils is a REST Client written in go. Easily consume any REST API's. Supported Response formats: JSON

Install

go get github.com/bndr/gopencils

Simple to use

Gopencils was designed to help you easily make requests to REST APIs without much hassle. It supports both Basic-Auth as well as OAuth.

Example Basic-Auth

type UserExample struct {
	Id            string
	Name          string
	Origin        string
	Url           string
	SomeJsonField string
}
// Create Basic Auth
auth := gopencils.BasicAuth{"username", "password"}

// Create New Api with our auth
api := gopencils.Api("http://your-api-url.com/api/", &auth)

// Create a pointer to our response struct
resp := &UserExample{}

// Perform a GET request
// URL Requested: http://your-api-url.com/api/users/1
api.Res("users", resp).Id(1).Get()

// Get Single Item
api.Res("users", resp).Id(1).Get()

// Perform a GET request with Querystring
querystring := map[string]string{"page": "100", "per_page": "1000"}

// URL Requested: http://your-api-url.com/api/users/123/items?page=100&per_page=1000
resource := api.Res("users").Id(123).Res("items", resp).Get(querystring)

// Now resp contains the returned json object
// resource.Raw contains raw http response,

// You can supply Path suffix to the api which will be applied to every url
// e.g /items/id.json
api := gopencils.Api("http://your-api-url.com/api/", &auth, ".json")

Example Github Api

package main

import (
	"fmt"
	"github.com/bndr/gopencils"
)

type respStruct struct {
	Login string
	Id    int
	Name  string
}

func main() {
	api := gopencils.Api("https://api.github.com")
	// Users Resource
	users := api.Res("users")

	usernames := []string{"bndr", "torvalds", "coleifer"}

	for _, username := range usernames {
		// Create a new pointer to response Struct
		r := new(respStruct)
		// Get user with id i into the newly created response struct
		_, err := users.Id(username, r).Get()
		if err != nil {
			fmt.Println(err)
		} else {
			fmt.Println(r)
		}
	}
}

More examples in the examples folder.

Why?

I work a lot with REST APIs and I caught myself writing the same code over and over, so I decided to make a library that would help me (and others) to quickly consume them.

Is it ready?

It is still in beta. But I would be glad if you could test it on your pet projects. The API will be improved, but no breaking changes are planned.

Contribute

All Contributions are welcome. The todo list is on the bottom of this README. Feel free to send a pull request.

License

Apache License 2.0

TODO

1. Add more Options (Flexibility)
2. Support XML Response
3. Better Error Handling

Documentation

Overview

Gopencils is a Golang REST Client with which you can easily consume REST API's. Supported Response formats: JSON

Index

• type ApiStruct
• type BasicAuth
• type Resource
  • func Api(baseUrl string, options ...interface{}) *Resource
  • func (r *Resource) Delete() (*Resource, error)
  • func (r *Resource) Get() (*Resource, error)
  • func (r *Resource) Head() (*Resource, error)
  • func (r *Resource) NewChildIdResource(id string) *Resource
  • func (r *Resource) NewChildResource(resourceName string, response interface{}) *Resource
  • func (r *Resource) Options() (*Resource, error)
  • func (r *Resource) Patch(payload interface{}) (*Resource, error)
  • func (r *Resource) Post(payload interface{}) (*Resource, error)
  • func (r *Resource) Put(payload interface{}) (*Resource, error)
  • func (r *Resource) SetClient(c *http.Client)
  • func (r *Resource) SetHeader(key string, value string)
  • func (r *Resource) SetPayload(args interface{}) io.Reader
  • func (r *Resource) SetQuery(querystring map[string]string) *Resource

Types

type ApiStruct

type ApiStruct struct {
	BaseUrl    *url.URL
	BasicAuth  *BasicAuth
	Client     *http.Client
	Cookies    *cookiejar.Jar
	PathSuffix string
}

Main Api Instance. No Options yet supported.

type BasicAuth

type BasicAuth struct {
	Username string
	Password string
}

Basic Auth

type Resource

type Resource struct {
	Api *ApiStruct
	Url string

	QueryValues url.Values
	Payload     io.Reader
	Headers     http.Header
	Response    interface{}
	Raw         *http.Response
	// contains filtered or unexported fields
}

Resource is basically an url relative to given API Baseurl.

func Api

func Api(baseUrl string, options ...interface{}) *Resource

Create a new API Instance and returns a Resource Accepts URL as parameter, and either a Basic Auth or a OAuth2 Client.

func (*Resource) Delete

func (r *Resource) Delete() (*Resource, error)

Performs a Delete request on given Resource. Call SetQuery beforehand if you want to set the query string of the DELETE request.

func (*Resource) Get

func (r *Resource) Get() (*Resource, error)

Performs a GET request on given Resource Call SetQuery beforehand if you want to set the query string of the GET request.

func (*Resource) Head

func (r *Resource) Head() (*Resource, error)

Performs a HEAD request on given Resource Call SetQuery beforehand if you want to set the query string of the HEAD request.

func (*Resource) NewChildIdResource

func (r *Resource) NewChildIdResource(id string) *Resource

Same as Res() Method, but returns a Resource with url resource/:id

func (*Resource) NewChildResource

func (r *Resource) NewChildResource(resourceName string, response interface{}) *Resource

Creates a new Resource.

func (*Resource) Options

func (r *Resource) Options() (*Resource, error)

Performs a OPTIONS request on given Resource. Call SetQuery beforehand if you want to set the query string of the OPTIONS request.

func (*Resource) Patch

func (r *Resource) Patch(payload interface{}) (*Resource, error)

Performs a PATCH request on given Resource. Accepts interface{} as parameter, will be used as payload.

func (*Resource) Post

func (r *Resource) Post(payload interface{}) (*Resource, error)

Performs a POST request on given Resource. Accepts interface{} as parameter, will be used as payload.

func (*Resource) Put

func (r *Resource) Put(payload interface{}) (*Resource, error)

Performs a PUT request on given Resource. Accepts interface{} as parameter, will be used as payload.

func (*Resource) SetClient

func (r *Resource) SetClient(c *http.Client)

Overwrites the client that will be used for requests. For example if you want to use your own client with OAuth2

func (*Resource) SetHeader

func (r *Resource) SetHeader(key string, value string)

Sets Headers

func (*Resource) SetPayload

func (r *Resource) SetPayload(args interface{}) io.Reader

Sets Payload for current Resource

func (*Resource) SetQuery

func (r *Resource) SetQuery(querystring map[string]string) *Resource

Sets QueryValues for current Resource