Open APIs

Expand all | Collapse all

API versioning

  • 1.  API versioning

    TM Forum Member
    Posted Jun 06, 2017 16:48
    How does one manage API versioning and backwards compatibility on a production network, what are the pain points that need greater attention?

    ------------------------------
    Joseph Alexander
    Ciena Corporation
    ------------------------------


  • 2.  RE: API versioning

    Posted Jun 07, 2017 02:11
    Are you referring to for instance a open rest API?

    In this case it depends on the consumers of the API and what your preference is (ease of use, semantically correctness). You mostly see either one of the three below.

    1. Adding version in the URL (ease of use is high, semantic correctness low)
    2. Modifying the Accept header in the request and add the version there (less ease of use, but higher semantically correct since now you are asking the client what version it is requesting)
    Accept: application/vnd.yourcustomname.v2+json
    3. Adding a custom header (actually not easy to use and not correct)

    I think the best strategy is to always try to minimise backward compatibility issues and if you need to do it be clear on when a specific version will become end of life.

    ------------------------------
    Jeroen Van der Laan
    Eurofiber Group
    ------------------------------



  • 3.  RE: API versioning

    Posted Jun 30, 2021 12:55
    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
    ------------------------------