Skip to main content

Module api

Module api 

Source
Expand description

The HTTP API, served over TLS only.

Structs§

App
What the API serves from.
Limits
The limits from configuration that the API applies to every request.

Enums§

TlsError
Why the TLS configuration could not be made.

Constants§

OPENAPI
The OpenAPI description of every route, as GET /openapi.json serves it and the website publishes it.

Functions§

router
The routes, served from app.
serve
Serves app on listener over TLS until shutdown completes. A connection whose handshake fails, such as plain HTTP, is dropped; the server goes on.
tls_config
The server’s TLS configuration from a PEM certificate chain and a PEM private key.