feat(architecture): Add ResponseInterceptor for consistent API response envelope (#839)#401
Open
Gezziy wants to merge 1 commit into
Open
feat(architecture): Add ResponseInterceptor for consistent API response envelope (#839)#401Gezziy wants to merge 1 commit into
Gezziy wants to merge 1 commit into
Conversation
|
@TochukwuJustice is attempting to deploy a commit to the vic's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
@Gezziy Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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.
closes #374
Summary of Changes
ResponseInterceptorinsrc/common/interceptors/response.interceptor.tsto wrap all REST API success responses inside a standard{ data, meta }envelope.{ data: response, meta: {} }.{ items: T[], total: number }or{ data: T[], total: number }to{ data: items, meta: { total } }.{ data, meta }payloads without double-wrapping.response.headersSent,204 No Content,304 Not Modified,Bufferpayloads, andStreamableFileinstances).ResponseInterceptorglobally inmain.ts.src/common/interceptors/response.interceptor.spec.tsvalidating all formatting rules and bypass cases.Reason for Changes
Currently, REST API endpoints return inconsistent shapes (some raw arrays, some pagination objects, some enveloped objects). This forces the frontend to write custom parsing logic for each endpoint. Standardizing on a
{ data, meta }envelope allows the client to process responses consistently.