https://github.com/ducdetronquito/requestz

HTTP client for Zig 🦎
https://github.com/ducdetronquito/requestz

http zig

Last synced: about 2 months ago
JSON representation

HTTP client for Zig 🦎

• Host: GitHub
• URL: https://github.com/ducdetronquito/requestz
• Owner: ducdetronquito
• License: 0bsd
• Archived: true
• Created: 2020-07-07T11:37:34.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-11T12:29:42.000Z (over 1 year ago)
• Last Synced: 2024-05-03T12:12:08.070Z (5 months ago)
• Topics: http, zig
• Language: Zig
• Homepage:
• Size: 39.1 KB
• Stars: 114
• Watchers: 3
• Forks: 12
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Requestz

An HTTP client inspired by [httpx](https://github.com/encode/httpx) and [ureq](https://github.com/algesten/ureq).

[![Build Status](https://api.travis-ci.org/ducdetronquito/requestz.svg?branch=master)](https://travis-ci.org/ducdetronquito/requestz) [![License](https://img.shields.io/badge/License-BSD%200--Clause-ff69b4.svg)](https://github.com/ducdetronquito/requestz#license) [![Requirements](https://img.shields.io/badge/zig-master_(19.08.2021)-orange)](https://ziglang.org/)

⚠️ I'm currently renovating an old house which does not allow me to work on [requestz](https://github.com/ducdetronquito/requestz/), [h11](https://github.com/ducdetronquito/h11/) and [http](https://github.com/ducdetronquito/http) anymore. Feel free to fork or borrow some ideas if there are any good ones :)

## Installation

*requestz* is available on [astrolabe.pm](https://astrolabe.pm/) via [gyro](https://github.com/mattnite/gyro)

```

gyro add ducdetronquito/requestz

```

## Usage

Send a GET request

```zig

const client = @import("requestz.zig").Client;

var client = try Client.init(std.testing.allocator);

defer client.deinit();

var response = try client.get("http://httpbin.org/get", .{});

defer response.deinit();

```

Send a request with headers

```zig

const Headers = @import("http").Headers;

var headers = Headers.init(std.testing.allocator);

defer headers.deinit();

try headers.append("Gotta-go", "Fast!");

var response = try client.get("http://httpbin.org/get", .{ .headers = headers.items() });

defer response.deinit();

```

Send a request with compile-time headers

```zig

var headers = .{

    .{"Gotta-go", "Fast!"}

};

var response = try client.get("http://httpbin.org/get", .{ .headers = headers });

defer response.deinit();

```

Send binary data along with a POST request

```zig

var response = try client.post("http://httpbin.org/post", .{ .content = "Gotta go fast!" });

defer response.deinit();

var tree = try response.json();

defer tree.deinit();

```

Stream a response

```zig

var response = try client.stream(.Get, "http://httpbin.org/", .{});

defer response.deinit();

while(true) {

    var buffer: [4096]u8 = undefined;

    var bytesRead = try response.read(&buffer);

    if (bytesRead == 0) {

        break;

    }

    std.debug.print("{}", .{buffer[0..bytesRead]});

}

```

Other standard HTTP method shortcuts:

- `client.connect`

- `client.delete`

- `client.head`

- `client.options`

- `client.patch`

- `client.put`

- `client.trace`

## Dependencies

- [h11](https://github.com/ducdetronquito/h11)

- [http](https://github.com/ducdetronquito/http)

- [iguanaTLS](https://github.com/alexnask/iguanaTLS)

- [zig-network](https://github.com/MasterQ32/zig-network)

## License

*requestz* is released under the [BSD Zero clause license](https://choosealicense.com/licenses/0bsd/). 🎉🍻