API Reference

These pages hold the docstrings of HTTP.jl's public API. The guides explain how the pieces fit together.

Module

HTTP.HTTP — Module
HTTP

An HTTP client and server library for HTTP/1.1 and HTTP/2, with WebSockets and server-sent events. Reseau provides the TCP, DNS, and TLS layers.

  • request, and get, post, put, patch, delete, head, options, and query, send a request and return the response.
  • open streams a request and its response.
  • serve! and serve run a server whose handler maps a Request to a Response.
  • listen! and listen run a server whose handler reads and writes a Stream.
  • WebSockets has the WebSocket client and server.
  • SSEEvent and sse_stream send server-sent events.
source

Reference Map

  • Core API: requests, responses, headers, errors, bodies, cookies, forms, proxies, and HTTP/2 settings.
  • Client API: Client, Transport, the request functions, streaming, retries, and trace events.
  • Server API: Server, Stream, routing, middleware, static files, and server-sent events.
  • WebSockets API: WebSocket clients, servers, and messages.