httppredicate

README

http

The http predicate does an HTTP request.

Options

Option	Required	Description
url	yes	URL to call
method		HTTP method (default to GET)
headers		headers to set
params		URL query params
body		Use body.string to send a text or body.json to send json.
response		set to JSON to parse the response.
basic_auth		set basic_auth.username & basic_auth.password

Results

Field	Type	Description
result	boolean	true if request was done
response		response as string or struct, depending of the response option
type	string	Content-Type
code	int	returned HTTP code

Example:

http:
  url: http://test/params
  method: post
  body:
    json:
      k1: v1
      k2: v2
  response: json
  basic_auth:
    username: myuser
    password: mypasswd
  params:
    k1: v1
    k2: v2
  headers:
    h1: v1
    h2: v2

Documentation

Index

• Variables
• func New() genapid.Predicate
• type Predicate
  • func (predicate *Predicate) Call(log zerolog.Logger, c *ctx.Ctx) bool
  • func (predicate *Predicate) Name() string
  • func (predicate *Predicate) Params() interface{}
  • func (predicate *Predicate) Result() ctx.Result

Variables

var Name = "http"

Name of the predicate

Functions

func New

func New() genapid.Predicate

New returns a new Predicate

Types

type Predicate

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

Predicate is a genapid.Predicate interface that describes the predicate

func (*Predicate) Call

func (predicate *Predicate) Call(log zerolog.Logger, c *ctx.Ctx) bool

Call evaluates the predicate

func (*Predicate) Name

func (predicate *Predicate) Name() string

Name returns the name of the predicate

func (*Predicate) Params

func (predicate *Predicate) Params() interface{}

Params returns a reference to a struct params accepted by the predicate

func (*Predicate) Result

func (predicate *Predicate) Result() ctx.Result

Result returns data set by the predicate