bndr / gopencils Goto Github PK

View Code? Open in Web Editor NEW

452.0 452.0 40.0 46 KB

Easily consume REST APIs with Go (golang)

License: Apache License 2.0

Go 100.00%

gopencils's Introduction

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

Add more Options (Flexibility)
Support XML Response
Better Error Handling

gopencils's People

Contributors

Stargazers

Watchers

gopencils's Issues

Do not read response body on non 1XX/2XX status codes

Sometimes API return error codes, and reply is not necessary even a JSON.

I mean, it should be JSON in correctly implemented REST API, but if server is uttrely broken you can get even a nginx default 404 page in the reply.

Even if reply is a JSON, it's probably incorrect to include error structures in the supposed normal reply structure to somehow output message to the user.

So, I think that non 100/200 error codes should leave body unparsed so gopencils user can parse it to the possible structure or just output it as text.

I can made PR if you agree on.

dynamic, and so using reflection etc

dont mean to sounds ungrateful but i am looking for something that code generates from a restful service, so that its easier to work with and also faster.

Have you thought at all about this.

Post Multipart Data

Posting multipart form data (with files) should be implemented.

Default http.Client timeout

In the API constructor when no Client is provided, the default one shall define a timeout value to 10 seconds for example.

https://medium.com/@nate510/don-t-use-go-s-default-http-client-4804cb19f779

PR can be provided if needed.

Api misusage

Imagine following case: _, r := api.Res("users", resp).Id(123).Get(). After this call resp value will be not populated, and only err returned by call will be json: Unmarshal(nil).

It's not so obvious to understand the problem.

Maybe, more clear message should be returned?

Working with the resulting payload

Big disclaimer that I'm new to Go, but would love either a short example or a pointer to the appropriate JSON project that demonstrates how you consume/navigate the payload of the response. The README seems pretty clear about how to auth and construct restful urls, just looking for a pointer towards the next step. Thank you!