+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Overview · HTTP.jl v2.0.0</title><meta name="title" content="Overview · HTTP.jl v2.0.0"/><meta property="og:title" content="Overview · HTTP.jl v2.0.0"/><meta property="twitter:title" content="Overview · HTTP.jl v2.0.0"/><meta name="description" content="Documentation for HTTP.jl v2.0.0."/><meta property="og:description" content="Documentation for HTTP.jl v2.0.0."/><meta property="twitter:description" content="Documentation for HTTP.jl v2.0.0."/><meta property="og:url" content="https://juliaweb.github.io/HTTP.jl/stable/api/reference/"/><meta property="twitter:url" content="https://juliaweb.github.io/HTTP.jl/stable/api/reference/"/><link rel="canonical" href="https://juliaweb.github.io/HTTP.jl/stable/api/reference/"/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">HTTP.jl v2.0.0</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Guides</span><ul><li><a class="tocitem" href="../../guides/client/">Client</a></li><li><a class="tocitem" href="../../guides/server/">Server</a></li><li><a class="tocitem" href="../../guides/protocols/">Protocols</a></li><li><a class="tocitem" href="../../guides/migration-1x/">Migration from 1.x</a></li></ul></li><li><span class="tocitem">API Reference</span><ul><li class="is-active"><a class="tocitem" href>Overview</a><ul class="internal"><li><a class="tocitem" href="#Module"><span>Module</span></a></li><li><a class="tocitem" href="#Reference-Map"><span>Reference Map</span></a></li></ul></li><li><a class="tocitem" href="../core/">Core</a></li><li><a class="tocitem" href="../client/">Client</a></li><li><a class="tocitem" href="../server/">Server</a></li><li><a class="tocitem" href="../websockets/">WebSockets</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API Reference</a></li><li class="is-active"><a href>Overview</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Overview</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaWeb/HTTP.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaWeb/HTTP.jl/blob/master/docs/src/api/reference.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="API-Reference"><a class="docs-heading-anchor" href="#API-Reference">API Reference</a><a id="API-Reference-1"></a><a class="docs-heading-anchor-permalink" href="#API-Reference" title="Permalink"></a></h1><p>This section is the canonical placement for exported <code>HTTP.jl</code> 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.</p><h2 id="Module"><a class="docs-heading-anchor" href="#Module">Module</a><a id="Module-1"></a><a class="docs-heading-anchor-permalink" href="#Module" title="Permalink"></a></h2><article><details class="docstring" open="true"><summary id="HTTP.HTTP"><a class="docstring-binding" href="#HTTP.HTTP"><code>HTTP.HTTP</code></a> — <span class="docstring-category">Module</span></summary><section><div><pre><code class="language-julia hljs">HTTP</code></pre><p>Client, server, streaming, WebSocket, and Server-Sent Events APIs for HTTP.jl.</p><p>The 2.0 API is built around explicit <code>Request</code>, <code>Response</code>, <code>Headers</code>, <code>RequestContext</code>, body, <code>Client</code>, <code>Transport</code>, <code>Server</code>, and <code>Stream</code> values. HTTP.jl owns HTTP message semantics and high-level client/server behavior, while <code>Reseau</code> provides the transport, resolver, and TLS substrate.</p><p>Common entrypoints:</p><ul><li><code>request</code>, <code>get</code>, <code>post</code>, <code>put</code>, <code>patch</code>, <code>delete</code>, <code>head</code>, <code>options</code>, and <code>query</code> for high-level client requests.</li><li><code>open</code> for client-side request/response streaming.</li><li><code>serve!</code> / <code>serve</code> for <code>Request -> Response</code> servers.</li><li><code>listen!</code> / <code>listen</code> and <code>streamhandler</code> for stream-oriented servers.</li><li><code>WebSockets</code> for WebSocket client and server helpers.</li><li><code>SSEEvent</code> and <code>sse_stream</code> for Server-Sent Events.</li></ul><p>See the migration guide for the most important 1.x to 2.0 API changes.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaWeb/HTTP.jl/blob/25388ae2e3f148dfc1ea5ad0133e84352149461f/src/HTTP.jl#L1-L22">source</a></section></details></article><h2 id="Reference-Map"><a class="docs-heading-anchor" href="#Reference-Map">Reference Map</a><a id="Reference-Map-1"></a><a class="docs-heading-anchor-permalink" href="#Reference-Map" title="Permalink"></a></h2><ul><li><a href="../core/">Core API</a>: request/response types, headers, bodies, cookies, forms, and proxy configuration.</li><li><a href="../client/">Client API</a>: <code>Client</code>, <code>Transport</code>, top-level requests, streaming, and connection reuse helpers.</li><li><a href="../server/">Server API</a>: <code>Server</code>, <code>Stream</code>, routing, middleware, static files, and SSE.</li><li><a href="../websockets/">WebSockets API</a>: WebSocket client/server types, messaging helpers, and server lifecycle operations.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../guides/migration-1x/">« Migration from 1.x</a><a class="docs-footer-nextpage" href="../core/">Core »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Friday 10 July 2026 15:46">Friday 10 July 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
0 commit comments