2021-06-12 20:18:21 +02:00
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog ](https://keepachangelog.com/en/1.0.0/ ),
and this project adheres to [Semantic Versioning ](https://semver.org/spec/v2.0.0.html ).
# Unreleased
2021-08-17 19:07:47 +02:00
- Overall compile time improvements. If you're having issues with compile time
please file an issue!
2021-08-19 22:37:48 +02:00
- Add dedicated `Router` to replace the `RoutingDsl` trait ([#214 ](https://github.com/tokio-rs/axum/pull/214 ))
2021-08-07 23:05:53 +02:00
- Make `FromRequest` default to being generic over `body::Body` ([#146 ](https://github.com/tokio-rs/axum/pull/146 ))
2021-08-07 21:03:04 +02:00
- Implement `std::error::Error` for all rejections ([#153 ](https://github.com/tokio-rs/axum/pull/153 ))
2021-08-19 21:24:32 +02:00
- Add `Router::or` for combining routes ([#108 ](https://github.com/tokio-rs/axum/pull/108 ))
2021-08-08 14:30:51 +02:00
- Add `handle_error` to `service::OnMethod` ([#160 ](https://github.com/tokio-rs/axum/pull/160 ))
2021-08-18 09:48:36 +02:00
- Add `OriginalUri` for extracting original request URI in nested services ([#197 ](https://github.com/tokio-rs/axum/pull/197 ))
2021-08-08 20:01:06 +02:00
- Implement `FromRequest` for `http::Extensions`
2021-08-17 17:28:02 +02:00
- Add `Headers` for easily customizing headers on a response ([#193 ](https://github.com/tokio-rs/axum/pull/193 ))
- Add `Redirect` response ([#192 ](https://github.com/tokio-rs/axum/pull/192 ))
2021-08-16 20:55:22 +02:00
- Make `RequestParts::{new, try_into_request}` public ([#194 ](https://github.com/tokio-rs/axum/pull/194 ))
2021-08-21 01:00:12 +02:00
- Support matching different HTTP methods for the same route that aren't defined
together. So `Router::new().route("/", get(...)).route("/", post(...))` now
accepts both `GET` and `POST` . Previously only `POST` would be accepted ([#224 ](https://github.com/tokio-rs/axum/pull/224 ))
2021-08-06 11:20:42 +02:00
## Breaking changes
2021-08-21 11:35:49 +02:00
- Remove `prelude` . Explicit imports are now required ([#195 ](https://github.com/tokio-rs/axum/pull/195 ))
- Replace `axum::route(...)` with `axum::Router::new().route(...)` . This means
there is now only one way to create a new router. Same goes for
`axum::routing::nest` . ([#215 ](https://github.com/tokio-rs/axum/pull/215 ))
2021-08-07 18:03:21 +02:00
- Add associated `Body` and `BodyError` types to `IntoResponse` . This is
required for returning responses with bodies other than `hyper::Body` from
handlers. See the docs for advice on how to implement `IntoResponse` ([#86 ](https://github.com/tokio-rs/axum/pull/86 ))
2021-08-21 11:35:49 +02:00
- Implement SSE as an `IntoResponse` instead of a service ([#98 ](https://github.com/tokio-rs/axum/pull/98 ))
2021-08-07 23:05:53 +02:00
- Replace `body::BoxStdError` with `Error` , which supports downcasting ([#150 ](https://github.com/tokio-rs/axum/pull/150 ))
2021-08-15 20:27:13 +02:00
- `get` routes will now also be called for `HEAD` requests but will always have
the response body removed ([#129 ](https://github.com/tokio-rs/axum/pull/129 ))
2021-08-07 17:26:23 +02:00
- Change WebSocket API to use an extractor ([#121 ](https://github.com/tokio-rs/axum/pull/121 ))
2021-08-07 20:24:13 +02:00
- Make WebSocket `Message` an enum ([#116 ](https://github.com/tokio-rs/axum/pull/116 ))
2021-08-07 23:05:53 +02:00
- `WebSocket` now uses `Error` as its error type ([#150 ](https://github.com/tokio-rs/axum/pull/150 ))
2021-08-07 22:35:41 +02:00
behavior ([#120 ](https://github.com/tokio-rs/axum/pull/120 ))
2021-08-07 23:05:53 +02:00
- Implement `routing::MethodFilter` via [`bitflags` ](https://crates.io/crates/bitflags )
2021-08-07 22:35:41 +02:00
- Removed `extract::UrlParams` and `extract::UrlParamsMap` . Use `extract::Path` instead
- `EmptyRouter` now requires the response body to implement `Send + Sync + 'static'` ([#108 ](https://github.com/tokio-rs/axum/pull/108 ))
2021-08-08 19:48:30 +02:00
- `extractor_middleware` now requires `RequestBody: Default` ([#167 ](https://github.com/tokio-rs/axum/pull/167 ))
- Convert `RequestAlreadyExtracted` to an enum with each possible error variant ([#167 ](https://github.com/tokio-rs/axum/pull/167 ))
2021-08-19 21:24:32 +02:00
- `Router::check_infallible` now returns a `CheckInfallible` service. This
2021-08-17 19:07:47 +02:00
is to improve compile times.
2021-08-07 22:35:41 +02:00
- These future types have been moved
- `extract::extractor_middleware::ExtractorMiddlewareResponseFuture` moved
to `extract::extractor_middleware::future::ResponseFuture` ([#133 ](https://github.com/tokio-rs/axum/pull/133 ))
- `routing::BoxRouteFuture` moved to `routing::future::BoxRouteFuture` ([#133 ](https://github.com/tokio-rs/axum/pull/133 ))
- `routing::EmptyRouterFuture` moved to `routing::future::EmptyRouterFuture` ([#133 ](https://github.com/tokio-rs/axum/pull/133 ))
- `routing::RouteFuture` moved to `routing::future::RouteFuture` ([#133 ](https://github.com/tokio-rs/axum/pull/133 ))
- `service::BoxResponseBodyFuture` moved to `service::future::BoxResponseBodyFuture` ([#133 ](https://github.com/tokio-rs/axum/pull/133 ))
2021-08-07 21:22:08 +02:00
- The following types no longer implement `Copy` ([#132 ](https://github.com/tokio-rs/axum/pull/132 ))
2021-08-07 16:13:56 +02:00
- `EmptyRouter`
- `ExtractorMiddleware`
- `ExtractorMiddlewareLayer`
2021-08-07 22:35:41 +02:00
- `QueryStringMissing`
2021-08-07 21:22:08 +02:00
- `RequestParts` changes ([#153 ](https://github.com/tokio-rs/axum/pull/153 ))
2021-08-07 20:24:13 +02:00
- `method` new returns an `&http::Method`
- `method_mut` new returns an `&mut http::Method`
- `take_method` has been removed
- `uri` new returns an `&http::Uri`
- `uri_mut` new returns an `&mut http::Uri`
- `take_uri` has been removed
- These rejections have been removed as they're no longer used
2021-08-07 21:22:08 +02:00
- `MethodAlreadyExtracted` ([#153 ](https://github.com/tokio-rs/axum/pull/153 ))
- `UriAlreadyExtracted` ([#153 ](https://github.com/tokio-rs/axum/pull/153 ))
- `VersionAlreadyExtracted` ([#153 ](https://github.com/tokio-rs/axum/pull/153 ))
- `UrlParamsRejection`
- `InvalidUrlParam`
2021-08-07 22:27:27 +02:00
- The following services have new response future types:
2021-08-07 22:35:41 +02:00
- `service::OnMethod`
- `handler::OnMethod`
- `routing::Nested`
2021-08-14 16:29:09 +01:00
- Remove `axum::sse` ([#98 ](https://github.com/tokio-rs/axum/pull/98 ))
2021-08-20 17:23:44 +02:00
- Add default feature `tower-log` which exposes `tower` 's `log` feature. ([#218 ](https://github.com/tokio-rs/axum/pull/218 ))
2021-08-06 11:20:42 +02:00
# 0.1.3 (06. August, 2021)
2021-08-02 22:40:33 +02:00
- Fix stripping prefix when nesting services at `/` ([#91 ](https://github.com/tokio-rs/axum/pull/91 ))
2021-08-06 11:20:42 +02:00
- Add support for WebSocket protocol negotiation ([#83 ](https://github.com/tokio-rs/axum/pull/83 ))
- Use `pin-project-lite` instead of `pin-project` ([#95 ](https://github.com/tokio-rs/axum/pull/95 ))
- Re-export `http` crate and `hyper::Server` ([#110 ](https://github.com/tokio-rs/axum/pull/110 ))
2021-08-04 23:13:09 +08:00
- Fix `Query` and `Form` extractors giving bad request error when query string is empty. ([#117 ](https://github.com/tokio-rs/axum/pull/117 ))
2021-08-06 16:17:57 +08:00
- Add `Path` extractor. ([#124 ](https://github.com/tokio-rs/axum/pull/124 ))
2021-08-06 16:31:38 +08:00
- Fixed the implementation of `IntoResponse` of `(HeaderMap, T)` and `(StatusCode, HeaderMap, T)` would ignore headers from `T` ([#137 ](https://github.com/tokio-rs/axum/pull/137 ))
2021-08-06 10:38:38 +02:00
- Deprecate `extract::UrlParams` and `extract::UrlParamsMap` . Use `extract::Path` instead ([#138 ](https://github.com/tokio-rs/axum/pull/138 ))
2021-08-01 22:13:43 +02:00
# 0.1.2 (01. August, 2021)
2021-07-31 21:05:53 +02:00
- Implement `Stream` for `WebSocket` ([#52 ](https://github.com/tokio-rs/axum/pull/52 ))
- Implement `Sink` for `WebSocket` ([#52 ](https://github.com/tokio-rs/axum/pull/52 ))
- Implement `Deref` most extractors ([#56 ](https://github.com/tokio-rs/axum/pull/56 ))
- Return `405 Method Not Allowed` for unsupported method for route ([#63 ](https://github.com/tokio-rs/axum/pull/63 ))
2021-07-31 21:36:30 +02:00
- Add extractor for remote connection info ([#55 ](https://github.com/tokio-rs/axum/pull/55 ))
2021-08-01 15:50:57 +02:00
- Improve error message of `MissingExtension` rejections ([#72 ](https://github.com/tokio-rs/axum/pull/72 ))
2021-08-01 15:42:50 +02:00
- Improve documentation for routing ([#71 ](https://github.com/tokio-rs/axum/pull/71 ))
2021-08-01 15:42:12 +02:00
- Clarify required response body type when routing to `tower::Service` s ([#69 ](https://github.com/tokio-rs/axum/pull/69 ))
- Add `axum::body::box_body` to converting an `http_body::Body` to `axum::body::BoxBody` ([#69 ](https://github.com/tokio-rs/axum/pull/69 ))
2021-08-01 21:49:17 +02:00
- Add `axum::sse` for Server-Sent Events ([#75 ](https://github.com/tokio-rs/axum/pull/75 ))
2021-08-01 21:33:55 +02:00
- Mention required dependencies in docs ([#77 ](https://github.com/tokio-rs/axum/pull/77 ))
2021-08-01 21:00:38 +02:00
- Fix WebSockets failing on Firefox ([#76 ](https://github.com/tokio-rs/axum/pull/76 ))
2021-06-12 20:18:21 +02:00
2021-07-30 17:20:38 +02:00
# 0.1.1 (30. July, 2021)
- Misc readme fixes.
2021-07-30 17:14:13 +02:00
# 0.1.0 (30. July, 2021)
2021-06-12 20:18:21 +02:00
2021-07-30 17:14:13 +02:00
- Initial release.