Open APIs

Expand all | Collapse all

API Versioning

  • 1.  API Versioning

    Posted Jul 23, 2019 09:10
    Hi all,
    Rules for API Versioning are  defined in TMF630_REST_API_Design_Guidelines_3.0_Part_1 _R17.5.1.pdf, page:91.
    "The versioning is applied uniformly to all the entities under a versioned API. That is, it is assumed that entities under the management scope of the API are all aligned with the same version of the SID for example."

    So, I try to find answer that question: Is it possible to have more than one API Versioning at the same time?


    ------------------------------
    memet harun ozer
    PiA Bilisim Hizmetleri Ltd.Turkey
    ------------------------------


  • 2.  RE: API Versioning

    TM Forum Member
    Posted Jul 23, 2019 13:55
    One main purpose of versioning APIs is so that we can introduce changes in the API signature (in some cases breaking backward compatibility). We put the major version in the endpoint string itself, for example:
    "basePath": "/tmf-api/serviceCatalogManagement/v4/",
    and we put the full version as a swagger attribute in the "info" section, for example:
    "version": "4.0.0"

    This versioning allows an implementation to continue supporting a given older version, or multiple versions, of the API, and a consumer to request a specific major version by setting in the endpoint.

    Hope it helps

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------



  • 3.  RE: API Versioning

    Posted Jun 28, 2021 11:19
    Hi,

    To answer you question I suggest you to have a look on this blog.
    https://www.meritedin.com/blogs/api-versioning

    This may answer your question.

    ------------------------------
    sowthri ganth
    TO BE VERIFIED
    ------------------------------



  • 4.  RE: API Versioning

    Posted Jun 30, 2021 12:32
    Hi,

    Please refer the below blog. You may have an idea on API Versioning.
    https://www.meritedin.com/robust-api.html

    Please don't forget to take a look on the videos listed on their playlist.

    ------------------------------
    sowthri ganth
    TO BE VERIFIED
    ------------------------------