http.zig

# An HTTP/1.1 server for Zig.

## Zig Version
This is for Zig 0.17.0. See the various branches for versions pinned to older versions.

## Example
```zig
const std = @import("std");
const httpz = @import("httpz");

pub fn main(init: std.process.Init) !void {
  const allocator = init.gpa;

  // More advanced cases will use a custom "Handler" instead of "void".
  // The last parameter is our handler instance; since we have a "void"
  // handler, we passed a void ({}) value.
  var server = try httpz.Server(void).init(init.io, allocator, .{
    // use .all(5882) to bind to all interfaces, i.e. 0.0.0.0
    .address = .localhost(5882),
  }, {});
  defer {
    // clean shutdown, finishes serving any live requests
    server.stop();
    server.deinit();
  }

  var router = try server.router(.{});
  router.get("/api/user/:id", getUser, .{});

  // blocks
  try server.listen();
}

fn getUser(req: *httpz.Request, res: *httpz.Response) !void {
  res.status = 200;
  try res.json(.{.id = req.param("id").?, .name = "Teg"}, .{});
}
```

# Table of Contents

- [Examples](#examples)
- [Installation](#installation)
- [Alternatives](#alternatives)
- [Handler](#handler)
  - [Custom Dispatch](#custom-dispatch)
  - [Per-Request Context](#per-request-context)
  - [Custom Not Found](#not-found)
  - [Custom Error Handler](#error-handler)
  - [Dispatch Takeover](#takover)
- [Memory And Arenas](#memory-and-arenas)
- [httpz.Request](#httpzrequest)
- [httpz.Response](#httpzresponse)
- [Router](#router)
- [Middlewares](#middlewares)
- [Configuration](#configuration)
- [Metrics](#metrics)
- [Testing](#testing)
- [HTTP Compliance](#http-compliance)
- [Server Side Events](#server-side-events)
- [Websocket](#websocket)

# Versions

The `master` branch targets the latest **stable** release of Zig; the `dev` branch targets the latest version of Zig. If you're looking for an older version, look for `zig-X.YY` branches.

# Examples

See the [examples](https://github.com/karlseguin/http.zig/tree/master/examples) folder for examples. If you clone this repository, you can run `zig build example_#` to run a specific example:

```bash
$ zig build example_1
listening http://localhost:8800/
```

# Installation

1. Add http.zig as a dependency in your `build.zig.zon`:
   ```bash
   zig fetch --save "git+https://github.com/karlseguin/http.zig#master"
   ```
   The `master` branch tracks the latest stable release of Zig. If you're using a different version of Zig, use the appropriate branch.

2. In your `build.zig`, add the `httpz` module as a dependency to your program:
   ```zig
   const httpz = b.dependency("httpz", .{
       .target = target,
       .optimize = optimize,
   });
   
   // the executable from your call to b.addExecutable(...)
   exe.root_module.addImport("httpz", httpz.module("httpz"));
   ```


# Alternatives

If you're looking for a higher level web framework with more included functionality, consider [JetZig](https://www.jetzig.dev/) or [Tokamak](https://github.com/cztomsik