Make versioning and the notion of evolving API more visible

Haufe-Lexware / api-style-guide

Haufe API Style Guide

https://haufe-lexware.gitbooks.io/haufe-api-styleguide/content/

Apache License 2.0

233 stars 79 forks source link

Make versioning and the notion of evolving API more visible #15

Open DonMartin76 opened 8 years ago

DonMartin76 commented 8 years ago

Currently, the versioning of APIs is described under "URI components", which may not be prominent enough. Links between the following topics can be improved:

Evolvable API design (don't versionize)
Versioning (in case you screwed up and/or did a complete redesign)
Hypermedia elements (which can also help creating evolvable APIs)

hlgr360 commented 8 years ago

I have tried to make this more prominent. Can you check if it works for you.