Core API

The core module holds the fundamental types used throughout the library: requests, responses, headers, URIs, methods, and status codes (src/common/, src/client/request.zig, src/web/router/router.zig).

Client request

Requests go through the URL-first client engine — there is no request-object-first builder API:

var res = try client.post("https://api.example.com/data", .{
    .headers = &.{.{ .name = "Authorization", .value = "Bearer token" }},
    .json = "{\"foo\":\"bar\"}",
    .query = &.{.{ .name = "page", .value = "1" }},
    .bearerAuth = "token",
    .timeoutMs = 10_000,
});
defer res.deinit();

See Client and Request.

Client response

ClientResponse (src/client/request.zig):

Member	Description
status: u16	Numeric status code
headers: []Header	Response headers
body: []u8	Owned body bytes
deinit()	Free headers and body
header(name)	Header lookup (case-insensitive)
text() / bytes()	Body bytes
writeTo(writer)	Stream the body out
contentType()	Content-Type value
json(T) / jsonAlloc(T, allocator)	JSON decoding
isInformational() / isSuccess() / isRedirect()	Status class checks

Server response

Handlers return httpx.Response literals or Context helpers (ctx.html, ctx.text, ctx.renderJson, ctx.redirect, ...). See Server.

Headers

httpx.Headers (src/common/headers.zig) is an ordered multi-map:

Method	Description
init(allocator) / deinit()	Lifecycle
set(name, value)	Set/overwrite value
append(name, value)	Append value (multi-value headers)
get(name)	First value, case-insensitive
getAll(allocator, name)	All values
remove(name)	Remove header
contains(name)	Presence check
count() / clear()	Size and reset

Plain []Header ({ .name, .value }) slices are used for per-request headers.

URI

httpx.Uri.parse(...) parses RFC 3986 URIs:

const uri = try httpx.Uri.parse("https://user:pass@example.com:8080/path?query=1");

Field	Type	Description
scheme	[]const u8	"http", "https", or empty
userinfo	[]const u8	User info before @, or empty
host	[]const u8	Hostname or IP
port	u16	Explicit port (0 when absent; see effectivePort())
path	[]const u8	Resource path (defaults to /)
query	[]const u8	Query string, or empty
fragment	[]const u8	Fragment identifier, or empty