feat(base-route): Redirecting user on browser to reference path #88
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 implements a base route handler middleware that automatically redirects browser-based requests from the root path ("/") to "/reference". The middleware detects common browser user agents and only performs the redirect for browser-based requests, allowing API requests to proceed normally. A list of common browsers was used in the middleware to help distinguish between a user in a browser and a user who is not.
Related Issue
Link to issue #80
Motivation and Context
This change improves the user experience by automatically redirecting browser users to the API reference documentation when they visit the root URL. This ensures that human users find the documentation easily while maintaining the root endpoint's availability.
How Has This Been Tested?
Testing performed:
Screenshots (if appropriate):
Types of changes
Checklist: