Nicolas Fränkel

Evolving your APIs, a step-by-step approach

How do you evolve an API without breaking it for your users? This talk demonstrates a step-by-step approach using an API gateway.

Evolving your APIs, a step-by-step approach
#1about 1 minute

The challenge of evolving APIs without breaking changes

Evolving an API is difficult because initial development focuses on domain modeling, not long-term versioning strategies.

#2about 5 minutes

Using an API gateway instead of a reverse proxy

An API gateway is a specialized reverse proxy that handles modern, complex requirements like dynamic configuration and client-specific rate limiting.

#3about 4 minutes

Setting up the initial proxy route with Apache APISIX

The first step is to configure the API gateway to proxy requests to the existing upstream service without any downtime.

#4about 3 minutes

Creating a versioned route with path rewriting

Introduce a versioned path like /v1 and use the API gateway to rewrite the request path before forwarding it to the upstream service.

#5about 1 minute

Redirecting legacy endpoints using an HTTP 301 response

Deprecate the old, unversioned endpoint by configuring the API gateway to return an HTTP 301 permanent redirect to the new versioned URL.

#6about 5 minutes

Implementing rate limiting to encourage user registration

Use a custom Lua plugin to enforce rate limits on unauthenticated users, prompting them to register to get an API key for unlimited access.

#7about 2 minutes

Canary releasing the new API version with traffic splitting

Safely roll out the new API version by configuring the gateway to split a percentage of production traffic between the old and new upstreams.

#8about 2 minutes

Deprecating an old API version using HTTP headers

Formally deprecate the V1 endpoint by adding Deprecation, Link, and Sunset headers to the response, guiding clients to the new V2 endpoint.

#9about 6 minutes

Q&A on API versioning and management strategies

The audience asks questions about rate limiting per token, managing multiple versions, reverting changes, and the definition of API management.

Related jobs
Jobs that call for the skills explored in this talk.

Featured Partners

Related Articles

View all articles
CH
Chris Heilmann
With AIs wide open - WeAreDevelopers at All Things Open 2025
Last week our VP of Developer Relations, Chris Heilmann, flew to Raleigh, North Carolina to present at All Things Open . An excellent event he had spoken at a few times in the past and this being the “Lucky 13” edition, he didn’t hesitate to come and...
With AIs wide open - WeAreDevelopers at All Things Open 2025
BR
Benjamin Ruschin
What Developers Really Need to Create Great Code Demos
Every developer on earth has, at some point, had another developer to thank for a breakthrough, a success, an aha moment they wouldn’t have had without coming across that blog post, that open-source contribution, that reply on socials or that humble ...
What Developers Really Need to Create Great Code Demos
DC
Daniel Cranney
Dev Digest 188: CfP time, the risks of NPM and IKEA algorithms
Inside last week’s Dev Digest 188 . 🤖 GitHub Copilot CLI is now in public review 💻 Microsoft is bringing ‘vibe working’ to office apps 🎣 Attackers abuse AI tools to generate captchas in fishing attacks ⚠️ When LLMs autonomously attack 🧠 Common cause...
Dev Digest 188: CfP time, the risks of NPM and IKEA algorithms
DC
Daniel Cranney
Dev Digest 194: AI vs. Version Control, Password Louvre & Cursed Webdev
Inside last week’s Dev Digest 194 . 🧠 Learn how to become an AI-native software engineer 🤷‍♂️ How can you stand out when anyone can build anything? 👂 Whisper Leak allows listening to encrypted chats 🐝 What’s new the OWASP2025 Top Ten List 🙅‍♀️ Curse...
Dev Digest 194: AI vs. Version Control, Password Louvre & Cursed Webdev

From learning to earning

Jobs that call for the skills explored in this talk.

API Software Engineer

API Software Engineer

NEP The Netherlands
Hilversum, Netherlands

Intermediate
PHP
API
Java
REST
Azure
+17