gohttpclient

README

go-http-client

An enhanced http client for Golang

Documentation on go.dev 🔗

This package provides you a http client package for your http requests. You can send requests quicly with this package. If you want to contribute this package, please fork and create a pull request.

Installation

$ go get -u github.com/bozd4g/go-http-client/

Example Usage

package main

import (
	"context"
	"log"

	gohttpclient "github.com/bozd4g/go-http-client"
)

type Post struct {
	ID    int    `json:"id"`
	Title string `json:"title"`
}

func main() {
	ctx := context.Background()
	client := gohttpclient.New("https://jsonplaceholder.typicode.com")

	response, err := client.Get(ctx, "/posts/1")
	if err != nil {
		log.Fatalf("error: %v", err)
	}

	var post Post
	if err := response.Unmarshal(&post); err != nil {
		log.Fatalf("error: %v", err)
	}

	log.Printf(post.Title) // sunt aut facere repellat provident occaecati...
}

License

Copyright (c) 2020 Furkan Bozdag

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Index

• Constants
• type Client
  • func New(baseUrl string, opts ...ClientOption) *Client
  • func (c *Client) Connect(ctx context.Context, endpoint string, opts ...Option) (*Response, error)
  • func (c *Client) Delete(ctx context.Context, endpoint string, opts ...Option) (*Response, error)
  • func (c *Client) Get(ctx context.Context, endpoint string, opts ...Option) (*Response, error)
  • func (c *Client) Options(ctx context.Context, endpoint string, opts ...Option) (*Response, error)
  • func (c *Client) Patch(ctx context.Context, endpoint string, opts ...Option) (*Response, error)
  • func (c *Client) Post(ctx context.Context, endpoint string, opts ...Option) (*Response, error)
  • func (c *Client) PrepareRequest(ctx context.Context, method, endpoint string, opts ...Option) (*http.Request, error)
  • func (c *Client) Put(ctx context.Context, endpoint string, opts ...Option) (*Response, error)
  • func (c *Client) Trace(ctx context.Context, endpoint string, opts ...Option) (*Response, error)
• type ClientOption
  • func WithCustomHttpClient(client *http.Client) ClientOption
  • func WithDefaultHeaders() ClientOption
  • func WithTimeout(timeout time.Duration) ClientOption
• type Clienter
• type Header
• type Option
  • func WithBody(body []byte) Option
  • func WithHeader(key, value string) Option
  • func WithQuery(key, value string) Option
• type Response
  • func (r *Response) Body() []byte
  • func (r *Response) Cookies() []*http.Cookie
  • func (r *Response) Get() *http.Response
  • func (r *Response) Headers() http.Header
  • func (r *Response) Ok() bool
  • func (r *Response) Status() int
  • func (r *Response) Unmarshal(v any) error

Constants

const (
	DEFAULT_TIMEOUT = 10 * time.Second
)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a struct who has BaseUrl property

func New

func New(baseUrl string, opts ...ClientOption) *Client

New func returns a Client struct

func (*Client) Connect

func (c *Client) Connect(ctx context.Context, endpoint string, opts ...Option) (*Response, error)

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, endpoint string, opts ...Option) (*Response, error)

Delete func returns a request

func (*Client) Get

func (c *Client) Get(ctx context.Context, endpoint string, opts ...Option) (*Response, error)

Get func returns a request

func (*Client) Options

func (c *Client) Options(ctx context.Context, endpoint string, opts ...Option) (*Response, error)

func (*Client) Patch

func (c *Client) Patch(ctx context.Context, endpoint string, opts ...Option) (*Response, error)

Patch func returns a request

func (*Client) Post

func (c *Client) Post(ctx context.Context, endpoint string, opts ...Option) (*Response, error)

Post func returns a request

func (*Client) PrepareRequest

func (c *Client) PrepareRequest(ctx context.Context, method, endpoint string, opts ...Option) (*http.Request, error)

PrepareRequest func returns a request

func (*Client) Put

func (c *Client) Put(ctx context.Context, endpoint string, opts ...Option) (*Response, error)

Put func returns a request

func (*Client) Trace

func (c *Client) Trace(ctx context.Context, endpoint string, opts ...Option) (*Response, error)

type ClientOption

type ClientOption Option

func WithCustomHttpClient

func WithCustomHttpClient(client *http.Client) ClientOption

func WithDefaultHeaders

func WithDefaultHeaders() ClientOption

func WithTimeout

func WithTimeout(timeout time.Duration) ClientOption

type Clienter

type Clienter interface{}

Clienter is a interface who calls the methods

type Header

type Header struct {
	Value     string
	IsDefault bool
}

type Option

type Option func(c *Client)

func WithBody

func WithBody(body []byte) Option

func WithHeader

func WithHeader(key, value string) Option

func WithQuery

func WithQuery(key, value string) Option

type Response

type Response struct {
	// contains filtered or unexported fields
}

func (*Response) Body

func (r *Response) Body() []byte

func (*Response) Cookies

func (r *Response) Cookies() []*http.Cookie

func (*Response) Get

func (r *Response) Get() *http.Response

func (*Response) Headers

func (r *Response) Headers() http.Header

func (*Response) Ok

func (r *Response) Ok() bool

func (*Response) Status

func (r *Response) Status() int

func (*Response) Unmarshal

func (r *Response) Unmarshal(v any) error