Skip to content

Instantly share code, notes, and snippets.

@zdne

zdne/version.apib

Created February 25, 2016 14:42
Show Gist options
  • Save zdne/d81c1556567f0b75ea9b to your computer and use it in GitHub Desktop.
Save zdne/d81c1556567f0b75ea9b to your computer and use it in GitHub Desktop.
Download ZIP
Raw
version.apib
# API
## Globals Parameters
- version: 1.0 (string) - Version of the API
# Resource A [/{version}/some/path/to/a]
# Resource B [/{version}/some/path/to/b]
# Resource C [/{version}/c]
@zdne
Copy link
Author

zdne commented Mar 5, 2016

This was just a sketch of an idea.

Frankly I'd like to avoid building a facility for URL "versioning" in the API Blueprint since I do not want to encourage it at the expense of other methods (https://www.mnot.net/blog/2011/10/25/web_api_versioning_smackdown).

So that is why I am looking a more generic solution that would also address this. Looking into near future apiaryio/api-blueprint#286 should bring MSON syntax to URI parameters / path segments so introducing a global variables could be one way to go...

From a Hypermedia standpoint it does not really matter what the value URL has. I like your point on looking for a compromise tho!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment