http

Documentation

Index

• func Feature(config ...func(*Installer)) setup.Feature
• func Format(format string) miruken.Builder
• func Pipeline(policies ...Policy) miruken.Builder
• type Installer
  • func (i *Installer) DependsOn() []setup.Feature
  • func (i *Installer) Install(b *setup.Builder) error
• type Options
• type Policy
  • func BasicAuth(username, password string) Policy
  • func Client(client *http.Client) Policy
• type PolicyFunc
  • func (f PolicyFunc) Apply(req *http.Request, composer miruken.Handler, ...) (*http.Response, error)
• type Router
  • func (r *Router) Route(_ ..., routed api.Routed, _ ..., options Options, ctx miruken.HandleContext) *promise.Promise[any]

Functions

func Feature

func Feature(config ...func(*Installer)) setup.Feature

Feature configures http client support

func Format

func Format(format string) miruken.Builder

Format returns a miruken.Builder requesting a specific format.

func Pipeline

func Pipeline(policies ...Policy) miruken.Builder

Pipeline returns a miruken.Builder that registers policies to apply during http request processing.

Types

type Installer

type Installer struct{}

Installer configure http client support.

func (*Installer) DependsOn

func (i *Installer) DependsOn() []setup.Feature

func (*Installer) Install

func (i *Installer) Install(b *setup.Builder) error

type Options

type Options struct {
	Format      string
	ProcessPath string
	PublishPath string
	Pipeline    []Policy
}

Options customize http operations.

type Policy

type Policy interface {
	Apply(
		req *http.Request,
		composer miruken.Handler,
		next func() (*http.Response, error),
	) (*http.Response, error)
}

Policy defines custom behavior for http requests.

func BasicAuth

func BasicAuth(username, password string) Policy

func Client

func Client(client *http.Client) Policy

Client returns a Policy to use the supplied http.Client. This should be the last Policy in the pipeline.

type PolicyFunc

type PolicyFunc func(
	req *http.Request,
	composer miruken.Handler,
	next func() (*http.Response, error),
) (*http.Response, error)

PolicyFunc promotes a function to Policy.

func (PolicyFunc) Apply

func (f PolicyFunc) Apply(
	req *http.Request,
	composer miruken.Handler,
	next func() (*http.Response, error),
) (*http.Response, error)

type Router

type Router struct{}

Router routes messages over a http transport.

func (*Router) Route

func (r *Router) Route(
	_ *struct {
		handles.It
		api.Routes `scheme:"http,https"`
	}, routed api.Routed,
	_ *struct {
		args.Optional
		args.FromOptions
	}, options Options,
	ctx miruken.HandleContext,
) *promise.Promise[any]