Scribd Logo
Upload

Welcome to Scribd!

  • RestApI Versioning

    Uploaded by

    Lathasri Koyya
    6 views2 pages
    This document discusses different approaches to versioning a REST API, including URI path versioning where the API version is included in the path (e.g. /v1/products), URI parameter versioning where it is appended as a query parameter (e.g. /api/customers?v1=1.1), and using a custom header to indicate the accepted version (e.g. Accept-version: v1). Versioning is important for APIs as it allows for breaking changes while maintaining backwards compatibility and ensures users rely on stable interfaces.

    Original Description:

    Copyright

    © © All Rights Reserved

    Available Formats

    RTF, PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    Report this Document
    This document discusses different approaches to versioning a REST API, including URI path versioning where the API version is included in the path (e.g. /v1/products), URI parameter versioning where it is appended as a query parameter (e.g. /api/customers?v1=1.1), and using a custom header to indicate the accepted version (e.g. Accept-version: v1). Versioning is important for APIs as it allows for breaking changes while maintaining backwards compatibility and ensures users rely on stable interfaces.

    Copyright:

    © All Rights Reserved
    Download as RTF, PDF, TXT or read online from Scribd
    Flag for inappropriate content
    6 views2 pages

    RestApI Versioning

    Uploaded by

    Lathasri Koyya
    This document discusses different approaches to versioning a REST API, including URI path versioning where the API version is included in the path (e.g. /v1/products), URI parameter versioning where it is appended as a query parameter (e.g. /api/customers?v1=1.1), and using a custom header to indicate the accepted version (e.g. Accept-version: v1). Versioning is important for APIs as it allows for breaking changes while maintaining backwards compatibility and ensures users rely on stable interfaces.

    Copyright:

    © All Rights Reserved
    Download as RTF, PDF, TXT or read online from Scribd
    Flag for inappropriate content
    of 2

    Rest API Versioning:

    Why is versioning improvement?

    Requirement change

    users rely on the API

    URI path Versioning:

    This is the most commonly used and straightforward approach while versioning a REST API. Let’s take an
    example of following resources – products and customers.

    https://hostname/v1/products

    https://hostname/v1/customers

    Let’s assume that we are introducing groundbreaking changes to the REST API, to represent this, we
    introduce a new version to our REST API resource structure

    https://hostname/v2/products

    https://hostname/v2/customers

    URI parameter versioning:

    Append version as a query parameter.

    http//locaolhost:8000/api/customers?v1=1.1

    Versioning using Custom Header:

    Accept-version: v1

    Accept-version: v2

    You might also like