Skip to content

🔰 The clean and easy way to build powerful http client libraries

License

Notifications You must be signed in to change notification settings

oddgames/httpclient

 
 

Repository files navigation

httpclient
CircleCI Go Report Card GoDoc

httpclient is a simple convenience package for performing http/api requests in Go. It wraps the standard libraries net/http package to avoid the repetitive http logic you're likely so familiar with. It helps to remove a good amount of the boilerplate involved with writing an http client library. Using the lib is very simple - Below is a very basic example.

Usage

package main

import (
	"log"
	"net/http"

	"s32x.com/httpclient"
)

var user = "s32x"

func main() {
	c := httpclient.New().WithBaseURL("https://api.github.com")

	var ghSuccess interface{} // A generic success response
	var ghError struct {
		Message       string `json:"message"`
		Documentation string `json:"documentation"`
	}

	expected, err := c.
		Getf("/users/%s/repos", user).
		WithExpectedStatus(http.StatusOK).
		WithRetry(5).
		JSONWithError(&ghSuccess, &ghError)
	if err != nil {
		log.Fatal(err)
	}
	if !expected {
		log.Println("Error :", ghError)
	} else {
		log.Println("Success :", ghSuccess)
	}
}

The BSD 3-clause License

Copyright (c) 2019, Steven Wolfe. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of httpclient nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

About

🔰 The clean and easy way to build powerful http client libraries

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 99.4%
  • Makefile 0.6%