feat: add API versioning and error contract - #9
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
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.
What
Adds an
/api/v1namespace, a versioned base controller with centralised error handling, and a JSON spec helper.Why
Every error response now has one predictable shape, so clients handle failures generically instead of special-casing each endpoint. Versioning means a future breaking change can ship as
/api/v2without stranding existing consumers.How
rescue_fromhandlers are matched bottom-up, soStandardErroris declared first and specific exceptions after (500 inverse).Testing
bundle exec rspecgreen