domainstack-http 1.0.0

Framework-agnostic HTTP helpers for domainstack: boundary validation for web APIs
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

# domainstack-http

[![Blackwell Systems™](https://raw.githubusercontent.com/blackwell-systems/blackwell-docs-theme/main/badge-trademark.svg)](https://github.com/blackwell-systems)
[![Crates.io](https://img.shields.io/crates/v/domainstack-http.svg)](https://crates.io/crates/domainstack-http)
[![Documentation](https://docs.rs/domainstack-http/badge.svg)](https://docs.rs/domainstack-http)
[![License: MIT OR Apache-2.0](https://img.shields.io/badge/License-MIT%20OR%20Apache--2.0-blue.svg)](https://github.com/blackwell-systems/domainstack/blob/main/LICENSE-MIT)

Framework-agnostic HTTP error handling for the [domainstack](https://crates.io/crates/domainstack) full-stack validation ecosystem.

## Overview

This crate provides shared HTTP error types and utilities used by framework-specific adapters like `domainstack-axum` and `domainstack-actix`.

**Most users should use framework adapters directly** instead of this crate:
- [domainstack-axum](https://crates.io/crates/domainstack-axum) - For Axum web framework
- [domainstack-actix](https://crates.io/crates/domainstack-actix) - For Actix-web framework

## Usage

Only use this crate directly if you're:
1. Building a new framework adapter for domainstack
2. Need framework-agnostic error handling

Add this to your `Cargo.toml`:

```toml
[dependencies]
domainstack = "1.0"
domainstack-http = "1.0"
```

## Types

**ErrorResponse** - Framework-agnostic HTTP error response:

```rust
use domainstack_http::ErrorResponse;
use domainstack::ValidationError;

let validation_error = ValidationError::single(
    Path::from("email"),
    "invalid_email",
    "Invalid email format"
);

let response = ErrorResponse::from(validation_error);
// Contains error-envelope formatted response with 400 status
```

## Framework Adapters

This crate is used internally by:

- **domainstack-axum** - Implements `IntoResponse` for Axum
- **domainstack-actix** - Implements `ResponseError` for Actix-web

Both adapters use `ErrorResponse` as their common error type and add framework-specific trait implementations.

## Building Custom Adapters

If you're integrating domainstack with another web framework:

1. Add `domainstack-http` and `domainstack-envelope` dependencies
2. Use `ErrorResponse` as your error type
3. Implement your framework's error trait
4. Convert `ErrorResponse::inner` (which is `error_envelope::Error`) to your framework's response type

See `domainstack-axum` or `domainstack-actix` source code for reference implementations.

## Documentation

For complete documentation and examples, see:

- [domainstack documentation](https://docs.rs/domainstack)
- [domainstack-axum documentation](https://docs.rs/domainstack-axum)
- [domainstack-actix documentation](https://docs.rs/domainstack-actix)
- [GitHub repository](https://github.com/blackwell-systems/domainstack)

## License

Apache 2.0