Versioning Protocols · Example Payload

Versioning Protocols Uri Path Versioning Example

API DesignBackward CompatibilitySoftware DevelopmentVersion ControlSemantic VersioningAPI LifecycleDeprecation

Versioning Protocols Uri Path Versioning Example is an example object payload from Versioning Protocols, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

basePathversionPrefixcurrentVersionsupportedVersionsdeprecatedVersionspaths

Example Payload

versioning-protocols-uri-path-versioning-example.json Raw ↑ 
{
  "basePath": "/api",
  "versionPrefix": "v",
  "currentVersion": 2,
  "supportedVersions": [
    1,
    2
  ],
  "deprecatedVersions": [
    1
  ],
  "paths": [
    {
      "version": 2,
      "path": "/api/v2",
      "deprecated": false
    },
    {
      "version": 1,
      "path": "/api/v1",
      "deprecated": true,
      "sunsetDate": "2027-01-01"
    }
  ]
}