https://github.com/muhammad-fiaz/api.zig
High-performance, multi-threaded HTTP API framework for Zig
https://github.com/muhammad-fiaz/api.zig
api api-package api-zig graphql http-zig resful resful-api zig zig-api zig-api-package zig-http zig-lang zig-library zig-package zig-restful
Last synced: 1 day ago
JSON representation
High-performance, multi-threaded HTTP API framework for Zig
- Host: GitHub
- URL: https://github.com/muhammad-fiaz/api.zig
- Owner: muhammad-fiaz
- License: mit
- Created: 2025-12-15T14:22:30.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-12-16T13:34:36.000Z (4 months ago)
- Last Synced: 2026-04-22T15:40:31.807Z (5 days ago)
- Topics: api, api-package, api-zig, graphql, http-zig, resful, resful-api, zig, zig-api, zig-api-package, zig-http, zig-lang, zig-library, zig-package, zig-restful
- Language: Zig
- Homepage: https://muhammad-fiaz.github.io/api.zig/
- Size: 4.56 MB
- Stars: 11
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
High-performance, multi-threaded HTTP API framework for Zig - build blazing-fast APIs with compile-time safety.
📚 Documentation |
API Reference |
Quick Start |
Contributing
---
> Note: This Project is in active development. Currently, Breaking changes may occur in every commit. Use at your own risk.
## ✨ Features
- 🚀 **High Performance** - Zero runtime reflection, compile-time route validation
- ⚡ **Multi-Threaded** - Configurable thread pools for concurrent request handling
- 📝 **Automatic OpenAPI** - Auto-generated OpenAPI 3.1 specification
- 🎨 **Swagger UI & ReDoc** - Built-in interactive API documentation (Swagger UI 5.31.0, ReDoc 2.5.2)
- 🔒 **Type Safety** - Full compile-time type checking for routes and handlers
- 🔄 **Concurrency** - Thread-safe request handling with atomic counters
- 🎯 **GraphQL Support** - Built-in GraphQL Playground with GraphiQL 3.8.3
- 📦 **Zero Dependencies** - Pure Zig implementation
- 🌐 **Cross-Platform** - Linux, Windows, macOS
## UI Preview
## 📦 Installation
Add `api.zig` to your `build.zig.zon`:
```bash
zig fetch --save https://github.com/muhammad-fiaz/api.zig/archive/refs/heads/main.tar.gz
```
Then in your `build.zig`:
```zig
const api = b.dependency("api", .{
.target = target,
.optimize = optimize,
});
exe.root_module.addImport("api", api.module("api"));
```
## 🚀 Quick Start
```zig
const std = @import("std");
const api = @import("api");
fn hello() api.Response {
return api.Response.jsonRaw("{\"message\":\"Hello, World!\"}");
}
fn getUser(ctx: *api.Context) api.Response {
const id = ctx.param("id") orelse "0";
_ = id;
return api.Response.jsonRaw("{\"id\":1,\"name\":\"John Doe\"}");
}
pub fn main() !void {
var gpa = std.heap.GeneralPurposeAllocator(.{}){};
defer _ = gpa.deinit();
const allocator = gpa.allocator();
var app = api.App.init(allocator, .{
.title = "My API",
.version = "1.0.0",
});
defer app.deinit();
try app.get("/", hello);
try app.get("/users/{id}", getUser);
// Run with 4 worker threads
try app.run(.{ .port = 8000, .num_threads = 4 });
}
```
Run your server:
```bash
zig build run
```
Then visit:
- **http://localhost:8000/** — Your API
- **http://localhost:8000/docs** — Swagger UI
- **http://localhost:8000/redoc** — ReDoc
## ⚡ Multi-Threading
api.zig supports configurable thread pools for maximum performance:
```zig
// Single-threaded mode (default)
try app.run(.{ .port = 8000 });
// Multi-threaded with 4 workers
try app.run(.{ .port = 8000, .num_threads = 4 });
// Auto-detect CPU count
try app.run(.{ .port = 8000, .num_threads = null });
```
## 📚 API Reference
### HTTP Methods
```zig
try app.get("/resource", handler);
try app.post("/resource", handler);
try app.put("/resource/{id}", handler);
try app.delete("/resource/{id}", handler);
try app.patch("/resource/{id}", handler);
```
### Path Parameters
```zig
fn getUser(ctx: *api.Context) api.Response {
const user_id = ctx.param("id") orelse "0";
// Use user_id...
}
try app.get("/users/{id}", getUser);
```
### Response Types
```zig
// JSON response
api.Response.jsonRaw("{\"key\":\"value\"}");
// Text response
api.Response.text("Hello, World!");
// HTML response
api.Response.html("
Hello
");
// Error response
api.Response.err(.not_found, "{\"error\":\"Not found\"}");
// Redirect
api.Response.redirect("/new-location");
```
### Builder Pattern
```zig
api.Response.text("Created")
.setStatus(.created)
.setHeader("X-Custom", "value")
.withCors("*");
```
## 🧪 Testing
Run the test suite:
```bash
zig build test
```
## 🤝 Contributing
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details.
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 💖 Support
If you find this project helpful, please consider:
- ⭐ Starring the repository
- 🐛 Reporting bugs
- 💡 Suggesting new features
- 🔀 Submitting pull requests