Skip to main content

Configuration

Default configuration keys for @quik/http. See Config Keys and Environment Variables for the full generated table.

  • http.listen / http.port (defaults 127.0.0.1 / 7200) and http.urls.app / http.urls.ui control where the engine listens and the URLs generated for the app/UI.
  • http.paths.api / http.paths.docs (defaults /api/v1 / /api/docs) set the base paths for API and docs routes.
  • http.cookie.domain / http.cookie.secure / http.cookie.secret are the defaults HTTP engines use when writing or clearing cookies, unless endpoint code passes explicit IQCookieOptions.
  • http.cors.* configures Cross-Origin Resource Sharing (origin, methods, allowed/exposed headers, credentials).
  • http.session.* configures session store driver (memory, file, redis), secret, and TTL.
  • http.body.jsonLimit / urlencodedLimit / textLimit (default 1mb each) cap request body sizes.
  • http.timeouts.requestMs / headersMs / shutdownMs control request, header, and graceful-shutdown timeouts.
  • http.static.* configures static content serving and single-page-application fallback.
  • http.headers merges default response headers into every response; endpoint-specific headers override these.
  • docs.* controls whether OpenAPI/Scalar docs endpoints are exposed and whether they require basic-auth.

Abstract engine, not a server​

@quik/http defines the routing decorators, QRoute/QEvent/QContext contracts, and the IQHTTPEngine interface, but does not implement an engine itself. The IQHTTPEngine feature is only initialized when the bootstrap startHttpServer flag is set, and it stays unregistered until an implementation package such as @quik/http-express registers itself.