From 44fe9a2dea5d32ef2faa05574bf7c0133c80607a Mon Sep 17 00:00:00 2001 From: Junv Zhao Date: Mon, 13 May 2019 22:07:44 +1000 Subject: [PATCH] Update api versioning --- categories/application.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/categories/application.md b/categories/application.md index 4e493b5..e952fb8 100644 --- a/categories/application.md +++ b/categories/application.md @@ -129,6 +129,19 @@ redoc-cli bundle swagger.json ``` Some sample swagger files: +## Versioning + +### Proper define the version of your application + +According to [semver](https://semver.org/), the following is the general guideline. + +> Given a version number MAJOR.MINOR.PATCH, increment the: +> +> 1. MAJOR version when you make incompatible API changes, +> 2. MINOR version when you add functionality in a backwards-compatible manner, and +> 3. PATCH version when you make backwards-compatible bug fixes. +> Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format. + # Log and Error ## Sentry