DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Newsletter
Log In / Join
Refcards Trend Reports
Events Video Library
Refcards
Trend Reports

Events

View Events Video Library

Related

  • Identify API Policies for All Levels in the Application Network With API-Led Connectivity
  • Building Multi-Rail Payment Failover to Stop Latency Spikes and Double Debits
  • GET, POST, PUT, DELETE: Choosing HTTP Verbs in a Real .NET Core Web API, Not Just by the Textbook
  • Delegated Transport, Forked Authorization: Where Chat and AI-Agent Integrations Actually Break

Trending

  • Why Successful Tech Transformation Starts With Clarity
  • Build Production-Ready AI Phone Agents: Infrastructure, Models, and Telephony
  • The Pipeline Failed, But the Infrastructure Changed
  • Member Spotlight: Shai Almong

Draft This article hasn't been published, so readers can't see it.

In moderation This article is waiting for review, so readers can't see it yet.

Deleted This article has been deleted, so readers can't see it.

  1. DZone
  2. Data Engineering
  3. Databases
  4. API Versioning and Its Guidelines in Anypoint Platform

API Versioning and Its Guidelines in Anypoint Platform

API endpoint URL, and Anypoint API Manager entries in "API version", "Implementation URL" and "Consumer endpoint".

By 
Sadik Ali
·
Nov. 03, 20 · Analysis
Post on X (opens in a new tab) Share on LinkedIn (opens in a new tab)
17.8K Views

Join the DZone community Save articles, join the discussion, and download Refcards and Trend Reports with a free account.

Join for free Already a member? Log in

In What Part of a URL to Surface the API Version:

  • Encode the version just in the URL path, e.g., http://mypoliciessummarypapi.cloudhub.io/v1
  • Demands a DNS lookup of ans-policyholdersummary-papi.cloudhub.io to propose an API implementation (or API proxy) that encourages all version of the API, including planned major versions
  • Alternatively, all API invocations must be routed on the server-side to the API implementation that promotes the demanded version.
  • Promoted through URL mapping rules in Cloudhub Dedicated Load Balancers. 
  • Encode the version just in the host-name, e.g., http://mypoliciessummary-papiv1.cloudhub.io/ 
  • Allows infinity (major) versions of the API to be stiffened by different API implementations (or API proxies) externally having to do URL recasting.
  • Encode the version in the hostname and the URL path, e.g., http://mypoliciesummary-papi-v1.cloudhub.io/v1
  • Redundant but allows the URL path on its own to distinguish the requested API version, without URL rewriting. 
  • Concedes the same API implementation to expose endpoints for more than one major version.

API Versioning Guidelines:

The Acme Insurance C4E defines the following API versioning guidelines, which are fully supported by Anypoint Platform:

 Only reveal major API versions as v1, v2, etc. in RAML definition, API endpoint URL, and Anypoint API Manager entries in "API version", "Implementation URL" and "Consumer endpoint".

  • In the API endpoint URL expose the major API version only in the URL path
    • E.g., http://mypoliciessummary-papi.cloudhub.io/v1
    • Claims future major versions to either be implemented in the same API implementation or to route API invocations by URL mapping rules
    • To be increased as and when the need arises with Cloudhub Dedicated Load Balancer supported URL mapping.
    • Publish to Anypoint Exchange using the full semantic version in "Asset version", and refer to that from Anypoint API Manager "Asset version".

Hope it help.

API guidelines

Opinions expressed by DZone contributors are their own.

Related

  • Identify API Policies for All Levels in the Application Network With API-Led Connectivity
  • Building Multi-Rail Payment Failover to Stop Latency Spikes and Double Debits
  • GET, POST, PUT, DELETE: Choosing HTTP Verbs in a Real .NET Core Web API, Not Just by the Textbook
  • Delegated Transport, Forked Authorization: Where Chat and AI-Agent Integrations Actually Break

Partner Resources

×

Comments

Loading comments

The comments didn't load

Please try again in a moment.

Likes

Loading

The next likes didn't load. Please try again.

The likes didn't load

Please try again in a moment.

See who liked this

Log in or join DZone for free to see who liked this article.

Log in Join for free
  • RSS
  • X
  • Facebook

ABOUT US

  • About DZone
  • Support and feedback
  • Community research

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Core Program
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 3343 Perimeter Hill Drive
  • Suite 215
  • Nashville, TN 37211
  • [email protected]

Let's be friends:

  • RSS
  • X
  • Facebook