Clean up axum-extra'a new error-response feature (#3057)

tokio-rs · Dec 1, 2024 · f637955 · f637955
1 parent 84c3960
commit f637955
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/axum-extra/CHANGELOG.md b/axum-extra/CHANGELOG.md
@@ -10,10 +10,13 @@ and this project adheres to [Semantic Versioning].
 - **fixed:** `Host` extractor includes port number when parsing authority ([#2242])
 - **added:** Add `RouterExt::typed_connect` ([#2961])
 - **added:** Add `json!` for easy construction of JSON responses ([#2962])
+- **added:** Add `InternalServerError` response for logging an internal error
+  and returning HTTP 500 in a convenient way. ([#3010])
 
 [#2242]: https://github.com/tokio-rs/axum/pull/2242
 [#2961]: https://github.com/tokio-rs/axum/pull/2961
 [#2962]: https://github.com/tokio-rs/axum/pull/2962
+[#3010]: https://github.com/tokio-rs/axum/pull/3010
 
 # 0.10.0
 

diff --git a/axum-extra/Cargo.toml b/axum-extra/Cargo.toml
@@ -16,7 +16,7 @@ default = ["tracing", "multipart"]
 
 async-read-body = ["dep:tokio-util", "tokio-util?/io", "dep:tokio"]
 attachment = ["dep:tracing"]
-error_response = ["dep:tracing", "tracing/std"]
+error-response = ["dep:tracing", "tracing/std"]
 cookie = ["dep:cookie"]
 cookie-private = ["cookie", "cookie?/private"]
 cookie-signed = ["cookie", "cookie?/signed"]

diff --git a/axum-extra/src/lib.rs b/axum-extra/src/lib.rs
@@ -16,6 +16,7 @@
 //! `cookie-signed` | Enables the [`SignedCookieJar`](crate::extract::SignedCookieJar) extractor | No
 //! `cookie-key-expansion` | Enables the [`Key::derive_from`](crate::extract::cookie::Key::derive_from) method | No
 //! `erased-json` | Enables the [`ErasedJson`](crate::response::ErasedJson) response | No
+//! `error-response` | Enables the [`InternalServerError`](crate::response::InternalServerError) response | No
 //! `form` | Enables the [`Form`](crate::extract::Form) extractor | No
 //! `json-deserializer` | Enables the [`JsonDeserializer`](crate::extract::JsonDeserializer) extractor | No
 //! `json-lines` | Enables the [`JsonLines`](crate::extract::JsonLines) extractor and response | No

diff --git a/axum-extra/src/response/mod.rs b/axum-extra/src/response/mod.rs
@@ -9,10 +9,10 @@ mod attachment;
 #[cfg(feature = "multipart")]
 pub mod multiple;
 
-#[cfg(feature = "error_response")]
+#[cfg(feature = "error-response")]
 mod error_response;
 
-#[cfg(feature = "error_response")]
+#[cfg(feature = "error-response")]
 pub use error_response::InternalServerError;
 
 #[cfg(feature = "erased-json")]