beckon 0.3.1

Generate type-safe, async HTTP clients from endpoint definitions — a Rust proc macro.
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
82

# Changelog

All notable changes to this project are documented here.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.3.1]

Documentation and metadata only — no code or behavior changes.

### Documentation

- The crate-level docs (docs.rs) are now sourced from the README via
  `#![doc = include_str!("../README.md")]`, so docs.rs and crates.io no longer drift —
  auth, retries, `with_client`, and error handling are all documented in both places.
- README: documented the method-naming rule, and example links are now absolute so they
  resolve on crates.io and docs.rs.

### Changed

- Declared the minimum supported Rust version: `rust-version = "1.75"` (the generated
  mocking trait uses `async fn` in traits). This was already required; it is now explicit.

## [0.3.0]

This release contains breaking changes to the constructor signature and the generated
error enum.

### Added

- **The `Http` error variant now carries the response body.** A non-2xx response keeps the
  raw payload the server returned (`Http { status, reason, body }`), so the reason a request
  was rejected is no longer discarded. `Display` includes the body when present.

### Changed

- **Breaking:** `new` and `with_client` now take the timeout as
  `impl Into<Option<std::time::Duration>>` instead of `Option<u64>` milliseconds. Pass a
  `Duration` (e.g. `Duration::from_secs(5)`) or `None` for the 5-second default. This removes
  the footgun where `Some(30)` meant 30 **milliseconds**, not 30 seconds.
- **Breaking:** the generated error enum is now `#[non_exhaustive]` and the `Http` variant has
  a new `body` field. Exhaustive `match`es on it (from another crate) need a `_` arm.

## [0.2.0]

### Fixed

- **Path parameters are now percent-encoded.** A value such as `1/2` or `a?b` is
  encoded (`1%2F2`, `a%3Fb`) so it can no longer break out of its URL path segment.
  Previously it was substituted verbatim.

### Added

- `with_client(url, [auth], client, timeout)` constructor, so a caller-supplied
  `reqwest::Client` — and its connection pool, TLS config, proxy, or default headers —
  can be shared across clients. `new` now builds on top of it.
- The generated client struct derives `Clone` (cheap: `reqwest::Client` is `Arc`-backed),
  so it can be cloned into spawned tasks.

## [0.1.1]

### Documentation

- The crate-level example is now a compile-tested doctest instead of `ignore`,
  so it is verified against the public API on every build.

## [0.1.0]

Initial release of `beckon`.

`beckon` is the continuation of the crate previously published as `http-provider-macro`,
renamed for a clearer, single, consistent name across the macro, crate, and repository.

### Features

- `beckon!` macro that generates a type-safe, async HTTP client from endpoint definitions.
- Per-endpoint configuration: `method`, `path`, `req`, `res`, `path_params`, `query_params`,
  `headers`, `fn_name`, and `retries`.
- Built-in auth strategies: `Bearer`, `Basic`, and `ApiKey`.
- Global and per-endpoint retries with exponential backoff (5xx and timeouts only).
- A generated trait per client for mocking in tests, and a typed error enum.