The primary purpose of API versioning is to let you adopt new versions on your own schedule, without disrupting your existing production applications. It ensures a smooth transition between versions, giving you full control over when to integrate updates to the API.
Swift API versioning is implemented using Semantic Versioning (SemVer). For more information on semantic versioning, please refer to Semantic Versioning 2.0.0. SemVer is beneficial for tracking backward-compatible changes, new functionalities, and bug fixes. Major breaking changes are indicated by incrementing the major version number, while backward-compatible additions and bug fixes are reflected in minor version numbers.
Additionally, Swift APIs utilize URI versioning, incorporating version numbers into the URL path.
Example of Original Format
• Https://api- mock.qa.magellanlp.com/mock/billing/invoices/additive/{Parameter1}/{Parameter2}/{Parameter3}
Example of Version 1 Format
• Https://api-mock.qa.magellanlp.com/mock/billing/V1/invoices/additive/{Parameter1}/{Parameter2}/{Parameter3} [?api-version]
To view the parameters and output for each endpoint version, use the menu located to the right of the library name.
