add support for versioning using the 'Accept-Version' header#403
Merged
dblock merged 2 commits intoruby-grape:masterfrom May 10, 2013
Merged
Conversation
Member
|
I like it. Code looks great. Please update CHANGELOG and document the new strategy in the README. |
Contributor
Author
|
Thanks, I've updated the changelog and added documentation. |
Member
|
Nice work. |
dblock
added a commit
that referenced
this pull request
May 10, 2013
…n-header add support for versioning using the 'Accept-Version' header
|
Wouldn't this be ignored by caching layers? |
Member
|
@stevegraham You have a point. Practically though most APIs likely don't care as they don't set content expiration headers. Not sure whether we should have not merged this, but the caveat is important. |
|
@dblock I thought of a solution. If the server adds the header |
Member
|
So maybe this should be documented. Would love a pull request as a note to the feature? |
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
3 participants
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.
We'd like to be able to version our REST-like APIs using the Accept-Version header. This patch adds support and specs for the :accept_version_header strategy.
curl -H "Accept-Version=v1" http://localhost:9292/api/toysGrape::Middleware::Versioner does not expose the ability to register a custom versioning strategy, and this patch does not attempt to create a registration mechanism. We simply use the existing
caseswitcher to plug-in a new strategy.Although the
Accept-Versionheader is not a part of RFC 2616, various companies and frameworks follow the version header approach (e.g. http://mcavage.github.io/node-restify/). There are pros and cons to all of the currently popular versioning strategies (URI, Conneg, query strings), and the Accept-Version header is just one of many solutions to the various trade-offs.