http

package

v0.4.22 Latest Latest Go to latest Published: Apr 12, 2024 License: MIT Imports: 16 Imported by: 1

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

ADDR
- Address golang listen address in the Dial format
PORT default: 3000
- Port to be used for listening used if address is not specified
ENVIRONMENT default: edge
- Name of the current environment
MAX_HEADER_BYTES default: 1048576 (1 MB)
- MaxHeaderBytes controls the maximum number of bytes the server will read parsing the request header's keys and values, including the request line. It does not limit the size of the request body. If zero, DefaultMaxHeaderBytes is used.
IDLE_TIMEOUT default: 1h
- IdleTimeout is the maximum amount of time to wait for the next request when keep-alives are enabled. If IdleTimeout is zero, the value of ReadTimeout is used. If both are zero, ReadHeaderTimeout is used.
- Everything that can be parsed by ParseDuration
READ_TIMEOUT default: 60s
- ReadHeaderTimeout is the amount of time allowed to read request headers. The connection's read deadline is reset after reading the headers and the Handler can decide what is considered too slow for the body.
- Everything that can be parsed by ParseDuration
WRITE_TIMEOUT default: 60s
- WriteTimeout is the maximum duration before timing out writes of the response. It is reset whenever a new request's header is read. Like ReadTimeout, it does not let Handlers make decisions on a per-request basis.
- Everything that can be parsed by ParseDuration

Package http implements the basic pace microservice handlers and a standard microservice server configured via environment variables.

This section is empty.

This section is empty.

func Environment() string

Environment returns the name of the current server environment

func Router() *mux.Router

Router returns the default microservice endpoints for health, metrics and debugging

func Server(handler http.Handler) *http.Server

Server returns a http.Server configured using environment variables, following https://12factor.net/.

This section is empty.

Path	Synopsis
jsonapi Package jsonapi provides a serializer and deserializer for jsonapi.org spec payloads.	Package jsonapi provides a serializer and deserializer for jsonapi.org spec payloads.
generator Package generator translates an OpenAPIv3 specification into working go code that handles marshalling, error handling, parameter parsing and validation.	Package generator translates an OpenAPIv3 specification into working go code that handles marshalling, error handling, parameter parsing and validation.
middleware
runtime Package runtime contains functions for marshalling, error handling, parameter parsing and validation.	Package runtime contains functions for marshalling, error handling, parameter parsing and validation.
longpoll
middleware
oauth2 Package oauth2 provides a middelware that introspects the auth token on behalf of PACE services and populate the request context with useful information when the token is valid, otherwise aborts the request.	Package oauth2 provides a middelware that introspects the auth token on behalf of PACE services and populate the request context with useful information when the token is valid, otherwise aborts the request.
middleware
oidc
security
apikey
transport