[ENHANCEMENT] Add Request ID Middleware and Structured Error Handling#411
Open
Lochit-Vinay wants to merge 6 commits intofireform-core:mainfrom
Open
[ENHANCEMENT] Add Request ID Middleware and Structured Error Handling#411Lochit-Vinay wants to merge 6 commits intofireform-core:mainfrom
Lochit-Vinay wants to merge 6 commits intofireform-core:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
[Enhancement] Add request ID middleware and improve error responses
Closes #409
What I did
Added a middleware to attach a unique request ID (
X-Request-ID) to every request/responseImplemented global exception handlers for:
Standardized error response format across the API
Why this change
While testing the API, I noticed:
This change makes debugging easier and responses more consistent for API consumers.
Example
Request (invalid input)
{ "template_id": null, "input_text": "" }Response
{ "error": { "type": "ValidationError", "message": "Invalid request data", "details": [ { "field": "template_id", "issue": "Input should be a valid integer" }, { "field": "input_text", "issue": "Input text cannot be empty" } ] } }How I tested
uvicorn api.main:app --reload/docsX-Request-IDheader is present in responsesFiles changed
api/main.pyNotes