Skip to main content

Introduction

After an API project is initialized in FlowOn API Studio, it enters the draft phase. This stage is designed to facilitate iterative development, allowing functional consultants and developers to configure and refine API functionalities without impacting any live consumers. The draft state is fully editable, supporting continuous customization and testing as business needs evolve.

Once development in the draft phase is complete, the API project can transition to a published state via one of two version types:

  1. Major Version: Major versions are typically used to signal significant or breaking changes that could alter the API’s behavior or structure. These changes may introduce new endpoints, modify existing ones, or alter the overall logic of the API. Publishing a major version requires careful consideration, as it may necessitate adjustments by consumers who rely on the API.

  2. Minor Version: A minor version reflects smaller, non-breaking changes, such as bug fixes, performance improvements, or the addition of non-intrusive features. Consumers using previous versions of the API can continue their operations without any necessary changes, ensuring backward compatibility.

    API Versioning Figure 1: API Versioning

Upon publishing, both major and minor versions are rendered read-only, ensuring immutability. This read-only state guarantees that once a version is published, it can be consumed reliably and predictably by external systems, mitigating any risk of unexpected alterations post-release.

Drafting Based on Baseline Versions​

An essential capability within FlowOn API Studio is the ability to initiate a new draft based on a baseline version. This feature allows the creation of a new draft, leveraging an already published version as a stable foundation. It empowers developers to:

  • Evolve the API incrementally without disrupting the current production version.

  • Introduce new functionalities, enhance existing ones, or deprecate outdated endpoints in a controlled environment.

  • Preserve backward compatibility with minimal risk, using the baseline as a known good state from which further changes can be safely layered.

    Draft & Baseline Version Figure 2: Draft & Baseline Version

This mechanism promotes a sophisticated and iterative approach to development, enabling teams to respond to evolving requirements while maintaining a stable, reliable API for consumers.

Multi-Version Strategy​

FlowOn API Studio incorporates a robust multi-version strategy, which allows for the seamless management and coexistence of multiple API versions. This strategy is invaluable in scenarios where different consumers or systems may rely on varying versions of the same API. The multi-version approach is particularly beneficial in the following contexts:

Multi-Version Strategy Figure 3: Multi-Version Strategy

  • Legacy System Support: Older systems or clients that depend on earlier API versions can continue to function without disruption, even as new versions are published. This ensures that critical services remain available, preventing forced upgrades that could break existing functionality.

  • Controlled Evolution: Teams can release updates in a granular, controlled fashion. Minor updates can be applied to existing versions to address immediate needs, while major overhauls can be developed in parallel without destabilizing the production environment.

  • Tailored Versions for Specific Clients: In scenarios where different consumer groups have distinct requirements, multiple API versions allow tailored responses. For instance, certain clients may need a simplified version of the API, while others may require access to more advanced or customized features.

By maintaining multiple versions simultaneously, FlowOn API Studio enables organizations to meet diverse stakeholder needs, balance innovation with stability, and execute phased rollouts of new features. This versioning approach is underpinned by a comprehensive lifecycle management system that ensures each version is independently managed, monitored, and consumed.

Conclusion​

The API versioning lifecycle and multi-version strategy within FlowOn API Studio empower development teams to manage complex API ecosystems with ease. By supporting draft development, baseline versioning, and multi-version management, the studio enables iterative API development, minimizes the risk of disruptions, and ensures compatibility with evolving business needs.