client

README

go-http-client

This package provides a generic go client template for an HTTP API

Installation

go-http-client is compatible with modern Go releases in module mode, with Go installed:

go get github.com/NdoleStudio/go-http-client

Alternatively the same can be achieved if you use import in a package:

import "github.com/NdoleStudio/go-http-client"

Implemented

• Status Codes
  • GET /200: OK

Usage

Initializing the Client

An instance of the client can be created using New().

package main

import (
	"github.com/NdoleStudio/go-http-client"
)

func main()  {
	statusClient := client.New(client.WithDelay(200))
}

Error handling

All API calls return an error as the last return object. All successful calls will return a nil error.

status, response, err := statusClient.Status.Ok(context.Background())
if err != nil {
    //handle error
}

Status Codes

GET /200: OK

status, response, err := statusClient.Status.Ok(context.Background())

if err != nil {
    log.Fatal(err)
}

log.Println(status.Description) // OK

Testing

You can run the unit tests for this client from the root directory using the command below:

go test -v

License

This project is licensed under the MIT License - see the LICENSE file for details

Documentation

Index

• type Client
  • func New(options ...Option) *Client
• type HTTPStatus
• type Option
  • func WithBaseURL(baseURL string) Option
  • func WithDelay(delay int) Option
  • func WithHTTPClient(httpClient *http.Client) Option
• type Response
  • func (r *Response) Error() error

Types

type Client

type Client struct {
	Status *statusService
	// contains filtered or unexported fields
}

Client is the campay API client. Do not instantiate this client with Client{}. Use the New method instead.

func New

func New(options ...Option) *Client

New creates and returns a new campay.Client from a slice of campay.ClientOption.

type HTTPStatus

type HTTPStatus struct {
	Code        int    `json:"code"`
	Description string `json:"description"`
}

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is options for constructing a client

func WithBaseURL

func WithBaseURL(baseURL string) Option

WithBaseURL set's the base url for the flutterwave API

func WithDelay

func WithDelay(delay int) Option

WithDelay sets the delay in milliseconds before a response is gotten. The delay must be > 0 for it to be used.

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) Option

WithHTTPClient sets the underlying HTTP client used for API requests. By default, http.DefaultClient is used.

type Response

type Response struct {
	HTTPResponse *http.Response
	Body         *[]byte
}

Response captures the http response

func (*Response) Error

func (r *Response) Error() error

Error ensures that the response can be decoded into a string inc ase it's an error response