apiaryio / api-blueprint

API Blueprint
https://apiblueprint.org
MIT License
8.63k stars 2.14k forks source link

How to deal with versioned APIs using URL prefix? #419

Open frankandrobot opened 6 years ago

frankandrobot commented 6 years ago

We're versioning using a URL prefix, for example, /v1/me and /v2/me. We can of course create two separate api blueprints but this is not ideal and would probably be problematic for us---the reason is because subsequent API versions will share a significant portion of the API, meaning this strategy increases the chance that docs go out of sync.

Ideally, it would be nice if there was a way to share endpoints between Groups---this is similar to how we'll actually code the backend.

anhldbk commented 5 years ago

@frankandrobot May this issue help you: https://stackoverflow.com/questions/32419425/does-apiary-io-and-or-api-blueprint-support-api-versioning