request

Documentation

Overview

Package request implements standardised ways of issuing outgoing calls to other servces.

Index

• Constants
• Variables
• func Create(options CreateOptions) (*http.Request, error)
• func Get(options GetOptions) (*http.Response, error)
• type CreateOptions
• type Doer
• type GetOptions

Constants

const (
	GetRequestTimeout = time.Second * 10
)

Variables

var ValidHTTPMethods = map[string]bool{
	http.MethodConnect: true,
	http.MethodDelete:  true,
	http.MethodGet:     true,
	http.MethodHead:    true,
	http.MethodOptions: true,
	http.MethodPatch:   true,
	http.MethodPost:    true,
	http.MethodPut:     true,
	http.MethodTrace:   true,
}

Functions

func Create

func Create(options CreateOptions) (*http.Request, error)

Create is a convenience function to increase readability in consuming code that needs to create an http.Request instance for calling an external service

func Get

func Get(options GetOptions) (*http.Response, error)

Types

type CreateOptions

type CreateOptions struct {
	Body    []byte
	Headers map[string][]string
	Method  string
	Queries map[string][]string
	URL     string
}

CreateOptions provides the input to the Create method

type Doer

type Doer interface {
	Do(*http.Request) (*http.Response, error)
}

Doer is an interface that defines an object like http.Client

type GetOptions

type GetOptions struct {
	URL     string
	Headers map[string]string
	Queries map[string]string
}