Industrial Internet Application Development

Versioning and documentation

As the adoption of APIs increases, we need to do versioning in order to support future changes. Because many users may not be in a position to upgrade at the same time, we have to use minor and major versions to handle changes. It is good to start using versions from the initial releases, as can be seen in the following examples:

• Minor versions: v1.1/iiot/devices
• Major versions: v2.0/iiot/devices

Documentation for the API is critical, and using a tool such as Swagger or API Docs is useful. No matter which tools you use, make sure you provide examples using Postman, which is very useful.