feat(api): implement API request utility and test suite #26
Conversation
This file contains 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
- Define apiRequest function in api.ts with 'GET', 'POST', 'PUT', and 'DELETE' support. - Add tests for api.ts
ishaan000
force-pushed
the
api-utility
branch
from
c37ad42 to
2a3639a
Compare
hiyaryan
requested changes
Jan 3, 2025
Co-authored-by: Ryan James Meneses <[email protected]>
- Handles API response parsing - Processes flash messages (success/error/info) - Throws standardized ApiError with status code - Includes Jest test
- Move error handling to separate utility function - Simplify default options structure - Add credentials option to API requests
- Change api.ts to apiRequest.ts - Change api.test.ts to apiRequest.test.ts
hiyaryan
requested changes
Jan 7, 2025
…ency - Remove handleApiError dependency and its test - Add TypeDoc documentation for apiRequest - Add simple error handling inside apiRequest
hiyaryan
requested changes
Jan 8, 2025
There was a problem hiding this comment.
Great work @ishaan000! I made some final suggestions. Please take a look then I'll go ahead merge it.
Co-authored-by: Ryan James Meneses <[email protected]>
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.
Description
This PR introduces a reusable API utility function and a test suite to streamline HTTP request handling across the application. The utility supports common HTTP methods, authentication, custom headers, and error handling, providing consistency and testability for API integrations.
Key Changes
API Utility (src/hooks/api.ts):
A single entry point for HTTP requests supporting GET, POST, PUT, and DELETE methods.
Accepts parameters:
url: Endpoint to call.
method: HTTP method (default: GET).
body: Payload for the request (if applicable).
headers: Custom headers for the request.
token: Bearer token for authentication.
Automatically uses process.env.NEXT_PUBLIC_BACKEND_URL
Handles structured error responses, including custom error messages (e.g., flash messages).
NEXT_PUBLIC Prefix in env variables : In order to make the value of an environment variable accessible in the browser, Next.js can "inline" a value, at build time, into the js bundle that is delivered to the client, replacing all references to process.env.[variable] with a hard-coded value. To tell it to do this, you just have to prefix the variable.