easyreq

easyreq

Make HTTP requests in go as easy as possible!

This package uses builtin net/http to make requests.

json and xml package will be used to unmarshal these types.

For now there is no support for third party packages.

Install

go get github.com/Navid2zp/easyreq

Usage

import (
	"github.com/Navid2zp/easyreq"
)

type MyData struct {
	Name     string `json:"name" xml:"name"`
	LastName string `json:"last_name" xml:"last_name"`
	Github   string `json:"github" xml:"github"`
}

func main() {

    sendData := MyData{
      Name: "Navid",
      LastName: "Zarepak",
      Github: "Navid2zp",
    }
    
    result := MyData{}
    
    ereq := easyreq.Request{
		URL:              "https://site.com/api",
		Method:           "post",
		Data:             []byte(sendData),
		RequestDataType:  "json",
		ResponseDataType: "json",
		SaveResponseTo:   &result,
		Headers: map[string]string{
			"Content-Type": "application/json",
		},
    }
    resp, err := ereq.Make()
    if err != nil {
        fmt.Println(err)
    }
    defer resp.CloseBody()
}

You can also make a request using Make() function:

res, err := easyreq.Make(
	"post", // Request method
	"https://site.com/api", // URL
	[]byte(sendData), // Data to send
	"json", // Request data type
	"json", // Response data type
	&result, map[string]string{"Content-Type": "application/json",}, // Headers
)

By providing ResponseDataType and SaveResponseTo package will try to parse the response to the given ResponseDataType and the result will be saved to where SaveResponseTo points.

easyreq.Request Args

Methods

Request shortcuts: Get(url string), Post(url string, data []byte), Put(url string, data []byte), Patch(url string, data []byte) and Delete(url string).

These methods can be called on Make() response which is a easyreq.RequestResponse Type containing the original response from request sent with net/http package.

// A pointer to your struct to save the data to.
// Uses 'json' package to unmarshal the response body.
// Returns error if anything goes wrong.
err := resp.ToJson(&result)

// A pointer to your struct to save the data to.
// Uses 'xml' package to unmarshal the response body.
// Returns error if anything goes wrong.
err := resp.ToXML(&result)

// A pointer to a string.
// Response body will be converted to string and saved to the given pointer.
// Returns error if anything goes wrong.
err := resp.ToString(&result)

Other useful methods:

// Returns status code (200, ...)
// Type: int
resp.StatusCode()

// Returns status code (200 OK) 
// Type: string
resp.Status()

// Returns response headers
// Type: http.Header
resp.Headers()

// Retunrs response body
// Type: io.ReadCloser
resp.Body()

// Reads response body into bytes using `ioutil` and returns the result.
Type: []byte, error
resp.ReadBody()

// Close response body
resp.CloseBody()

// Downloads the body and saves it into the given path.
Type: DownloadResult, error
resp.DownloadAsFile("myfile.zip")

You can also access the original response returned by http package by calling resp.Response. (Will be a pointer to original response)

License

MIT