README
¶
gocrayons - REST api consumer with simplejson
Summary
gocrayons is a fork of bndr/gopencils. The main change is the use of github.com/bitly/go-simplejson for JSON handling.
Install
go get github.com/cryptix/gocrayons
Usage example
Please see the examples directory.
Why?
simplejson makes it easier to work with strange and irregular json that can't be simple handled by encoding/json's Unmarshal()
Is it ready?
It is more beta than bndrs original.
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 examples
Documentation
¶
Overview ¶
Package gocrayons is a Golang REST Client with which you can easily consume REST API's. Uses bily/simplejson
Index ¶
- Variables
- type ApiStruct
- type BasicAuth
- type Resource
- func (r *Resource) Delete(params map[string]string) (*Resource, error)
- func (r *Resource) FormPost(params map[string]string) (*Resource, error)
- func (r *Resource) Get(params map[string]string) (*Resource, error)
- func (r *Resource) Head(params map[string]string) (*Resource, error)
- func (r *Resource) Id(id interface{}) *Resource
- func (r *Resource) Options(params map[string]string) (*Resource, error)
- func (r *Resource) Patch(options ...interface{}) (*Resource, error)
- func (r *Resource) Post(options ...interface{}) (*Resource, error)
- func (r *Resource) Put(options ...interface{}) (*Resource, error)
- func (r *Resource) Res(path string) *Resource
- 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(qry map[string]string) *Resource
- Bugs
Constants ¶
This section is empty.
Variables ¶
var ErrCantUseAsQuery = errors.New("can't use options[0] as Query")
Functions ¶
This section is empty.
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 Resource ¶
type Resource struct {
Api *ApiStruct
Url string
QueryValues url.Values
Payload io.Reader
Headers http.Header
Response *simplejson.Json
Raw *http.Response
// contains filtered or unexported fields
}
Resource is basically an url relative to given API Baseurl.
func Api ¶
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 ¶
Performs a Delete request on given Resource. Accepts map[string]string as parameter, will be used as querystring.
func (*Resource) Get ¶
Performs a GET request on given Resource Accepts map[string]string as parameter, will be used as querystring.
func (*Resource) Head ¶
Performs a HEAD request on given Resource Accepts map[string]string as parameter, will be used as querystring.
func (*Resource) Options ¶
Performs a Delete request on given Resource. Accepts map[string]string as parameter, will be used as querystring.
func (*Resource) Patch ¶
Performs a PATCH request on given Resource. Accepts interface{} as parameter, will be used as payload.
func (*Resource) Post ¶
Performs a POST request on given Resource. Accepts interface{} as parameter, will be used as payload.
func (*Resource) Put ¶
Performs a PUT request on given Resource. Accepts interface{} as parameter, will be used as payload.
func (*Resource) SetClient ¶
Overwrites the client that will be used for requests. For example if you want to use your own client with OAuth2
func (*Resource) SetPayload ¶
Sets Payload for current Resource
Notes ¶
Bugs ¶
don't panic..
Source Files
Directories