fix: set Location header on POST 201 and add WithBaseURL option#198
Merged
Conversation
resourcePostHandler never set the HTTP Location header on 201 responses, violating RFC 7644 Section 3.3 which states the server SHALL return the resource URI in the Location header. Additionally, meta.location and Location headers were always relative paths (e.g. "Users/123"). The RFC examples consistently use absolute URIs. Add a WithBaseURL server option that prepends a configurable base URL to all resource locations, enabling RFC-compliant absolute URIs when configured.
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.
resourcePostHandler never set the HTTP Location header on 201 responses, violating RFC 7644 Section 3.3 which states the server SHALL return the resource URI in the Location header.
Additionally, meta.location and Location headers were always relative paths (e.g. "Users/123"). The RFC examples consistently use absolute URIs. Add a WithBaseURL server option that prepends a configurable base URL to all resource locations, enabling RFC-compliant absolute URIs when configured.
Summary
Locationheader on 201 Created responses inresourcePostHandler, as required by RFC 7644 Section 3.3resourceLocation()function used by all handlers (GET, PATCH,POST, PUT) and list responses
WithBaseURLserver option to produce absolute URIs in bothmeta.locationand theLocationheader (e.g.https://example.com/v2/Users/123instead ofUsers/123)WithBaseURL, behavior is unchanged (relative paths)