ic-http-types 0.1.0

HTTP request and response types for the Internet Computer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# ic-http-types

`ic-http-types` is a Rust crate that provides types for representing HTTP requests and responses. These types are designed to simplify working with HTTP communication in canister development on the Internet Computer.

## Features

- **`HttpRequest`**: A struct for encapsulating HTTP request details, including method, URL, headers, and body.
- **`HttpResponse`**: A struct for encapsulating HTTP response details, including status code, headers, and body.
- **`HttpResponseBuilder`**: A builder pattern for constructing `HttpResponse` objects.

## Usage

Add the crate to your `Cargo.toml`:

```toml
[dependencies]
ic-http-types = "0.1.0"
```

#### Example

```rust
use ic_canisters_http_types::{HttpRequest, HttpResponseBuilder};
use serde_bytes::ByteBuf;

fn main() {
    // Create an HTTP request
    let request = HttpRequest {
        method: "GET".to_string(),
        url: "/path/to/resource?query=1".to_string(),
        headers: vec![("Content-Type".to_string(), "application/json".to_string())],
        body: ByteBuf::defaBult(),
    };

    // Extract the path from the request URL
    println!("Path: {}", request.path());

    // Build an HTTP response
    let response = HttpResponseBuilder::ok()
        .header("Content-Type", "application/json")
        .body("{\"message\": \"success\"}")
        .build();

    println!("Response Status: {}", response.status_code);
}
```

## Documentation
For detailed documentation, visit the [Rust Docs](https://docs.rs/ic-http-types).

## License
This project is licensed under the [Apache License 2.0](LICENSE).

## Contributing
If you decide to contribute, we encourage you to announce it on the [Forum](https://forum.dfinity.org/)!