fix: make cbor support optional #372
Merged
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
victoraugustolls
approved these changes
Apr 11, 2024
Contributor
victoraugustolls
left a comment
There was a problem hiding this comment.
Really liked the approach, LGTM!
Contributor
|
LGTM. |
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.
This PR makes the CBOR format optional in Huma's default config, removing the hard dependency and providing more flexibility in how default formats are set up. Technically this is not a breaking change, just a change in how defaults work, however existing users who wish to continue using CBOR must add a new import. If you set up your own config you are unaffected.
github.com/danielgtaylor/huma/v2/formats/cborhuma.DefaultFormatsmap which packages can modify. This is used byhuma.DefaultConfig(...).init()function to modify the default formats map when thecborpackage is imported. This is similar to how the standard library works and described in Effective Go, e.g. see net/http/pprof or thecryptoorsqlstdlib packages.After this change, using Huma to build an API supporting JSON with the Go 1.22
http.ServeMuxhas zero hard dependencies.