API Reference

This section is the canonical placement for exported HTTP.jl docstrings and the documented submodule APIs that make up the supported 2.0 surface. The guides explain how the pieces fit together; these pages are where the concrete names live.

Module

HTTP.HTTP — Module

HTTP

Client, server, streaming, WebSocket, and Server-Sent Events APIs for HTTP.jl.

The 2.0 API is built around explicit Request, Response, Headers, RequestContext, body, Client, Transport, Server, and Stream values. HTTP.jl owns HTTP message semantics and high-level client/server behavior, while Reseau provides the transport, resolver, and TLS substrate.

Common entrypoints:

request, get, post, put, patch, delete, head, and options for high-level client requests.
open for client-side request/response streaming.
serve! / serve for Request -> Response servers.
listen! / listen and streamhandler for stream-oriented servers.
WebSockets for WebSocket client and server helpers.
SSEEvent and sse_stream for Server-Sent Events.

See the migration guide for the most important 1.x to 2.0 API changes.

source

Reference Map

Core API: request/response types, headers, bodies, cookies, forms, and proxy configuration.
Client API: Client, Transport, top-level requests, streaming, and connection reuse helpers.
Server API: Server, Stream, routing, middleware, static files, and SSE.
WebSockets API: WebSocket client/server types, messaging helpers, and server lifecycle operations.