httpapi

package

v0.0.0-...-1eb86f4 Latest Latest Go to latest Published: Sep 4, 2019 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package httpapi provides a client and server for a remote http api.

This section is empty.

This section is empty.

This section is empty.

type Client struct {
	Endpoint   string
	HTTPClient HTTPClient
}

A Client marshals requests to send over the wire to a remote http server.

func (c *Client) Apply(ctx context.Context, req *api.ApplyRequest) (*api.ApplyResponse, error)

Apply marshals an ApplyRequest and sends it over the wire.

The type of req.Config must be *hclpack.Body.

type Error struct {
	Msg string `json:"message"`
}

An Error is a json encoded error message from the api.

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

HTTPClient is the client to use for communication.

type Server struct {
	API    api.API
	Logger *zap.Logger
	// contains filtered or unexported fields
}

Server is func http api server.

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.Handler.