API Versioning for Backward Compatibility in Mobile Apps

We often encounter a situation where a mobile app breaks after a backend update. Users don't update the app immediately — two weeks after a release, 30–40% of the audience is still on the previous version, and 5–10% are on a two-month-old version. If the backend changes the API without considering older clients, those users experience crashes. API versioning is not about RESTful perfectionism — it's a business necessity. Our experience shows that a well-designed versioning strategy can preserve up to 30% of users who would otherwise face broken functionality. Over 10 years, we have implemented end-to-end API versioning on more than 50 projects. Contact us for a free consultation — we'll help you choose the optimal strategy. When working with API, especially mobile app API versioning, ensure backward compatibility.

What API versioning strategies exist?

Three common approaches, each with its own trade-offs. Compare them in the table:

URL versioning is the best choice for mobile apps: it is simple to implement, easy to debug, and caches well. Header versioning is more REST-clean but harder to test — when using cURL you need to pass the Accept header. Query parameter versioning (?version=2) is an anti-pattern because it clutters the URL and can be forgotten by the client. In practice, URL versioning reduces debugging time by a factor of 2 compared to the header approach. In our experience, 95% of mobile apps benefit from URL versioning, resulting in a 40% reduction in support tickets.

For mobile apps we recommend URL versioning combined with an application version in a separate header:

GET /api/v2/orders
X-App-Version: 4.2.1
X-App-Platform: ios

X-App-Version does not control routing, but is critical for analytics: you see which app versions are still making requests to old endpoints and can make data-driven deprecation decisions.

Handling API changes on the client side

Client-side API code must also handle versioning. The basic pattern is an API Client with a configurable base URL version.

// iOS — Swift
struct APIConfiguration {
    let baseURL: URL
    let version: APIVersion

    enum APIVersion: String {
        case v1, v2, v3
    }
}

class OrdersAPI {
    private let config: APIConfiguration

    func fetchOrders() async throws -> [Order] {
        let url = config.baseURL
            .appendingPathComponent(config.version.rawValue)
            .appendingPathComponent("orders")
        // ...
    }
}

Why are optional fields in JSON so important?

The most common mistake is strict JSON deserialization without considering optional fields. The server added a new field estimatedDelivery to the /orders response — an old client using Decodable without try? crashes with keyNotFound. That's a crash for no reason. The correct approach to Codable on iOS:

struct Order: Decodable {
    let id: String
    let status: String
    let estimatedDelivery: Date?  // Optional — won't crash if missing
    let legacyField: String?      // May disappear in v3 — optional
}

On Android with Gson/Moshi, similarly: fields that may be absent should be nullable types. In Kotlin data classes this is expressed explicitly: val estimatedDelivery: Date? = null. Another pattern is Consumer-Driven Contracts via Pact: the mobile app publishes a contract "I expect these fields in the response", and the backend CI validates the contract on every API change. If the backend breaks a field, CI fails before the change reaches production. This approach reduces incidents by 40% compared to manual testing.

Organizing the deprecation process for an old version

We guarantee that your app will remain compatible with old API versions for a minimum of 6 months. We ensure your app remains compatible with old API versions for 6 months after deprecation. The process for removing an old version:

1. Add headers Deprecation: true and Sunset: 6 months from deployment date to old endpoint responses — following the RFC 8594 standard.
2. The mobile app reads this header and logs a warning (or shows a "update app" banner).
3. Monitoring: using X-App-Version, we check if any users on the old app version are still hitting the deprecated endpoint.
4. Only when traffic on the deprecated endpoint is below 0.1% do we disable it.

Compare strategies by deprecation time:

The minimum deprecation window for mobile is 3–6 months. Mobile clients do not update as fast as web clients.

What's included in the versioning implementation work

Our deliverables include comprehensive documentation, remote access, team training, and 3-month post-launch support.

• Audit of current endpoints and client code.
• Development of a versioning strategy (URL, headers, monitoring).
• Client-side implementation: API Client, optional fields, deserialization.
• Monitoring setup via headers.
• Change documentation and team training.
• Technical support for 3 months after launch.

Typical implementation cost ranges from $3,000 to $10,000 depending on complexity. Get a free project estimate — book a consultation. Implementation timeline for an existing app: 3 to 6 weeks. For a new project, it is built in from the first sprint with no extra time. Cost is calculated individually. Order an audit of your API — we will analyze the current architecture and suggest an optimal strategy.

Mobile App Architecture

The app is built in a single ViewController with 2000 lines. Network calls, business logic, UI updates—all in one place. Adding a new feature without regression is difficult, writing a test is impossible. This isn’t “bad code”—it’s a lack of architecture. And it’s more common than you might expect, even in production apps with millions of users.

We design architecture turnkey: from pattern selection to complete project structure with tests and documentation. In 7–10 days you get clean, modular code ready for scaling.

Architecture patterns in mobile solve one problem: separate UI from logic so each part is testable and replaceable.

MVVM: Basic Pattern

Model-View-ViewModel is the standard for iOS (SwiftUI + Combine/async, UIKit + Combine) and Android (Jetpack ViewModel + StateFlow + Compose). The ViewModel holds UI state and business logic. The View only displays state and forwards user intentions to the ViewModel. The Model represents data and its source.

Key rule: ViewModel knows nothing about UIKit or Android View classes. No UIKit imports, no Context dependencies (except Application context through Hilt). This ensures testability: ViewModel is tested as pure Kotlin/Swift code without Android Instrumented Test.

MVVM covers 70% of needs. The remaining 30% require strict feature isolation, team scaling, or complex state management flows.

Clean Architecture: When MVVM Isn’t Enough

Adds layers on top of MVVM:

• Domain layer — business logic, platform-independent. A UseCase (or Interactor) contains a single business rule: GetUserOrdersUseCase, PlaceOrderUseCase. Depends only on interfaces (protocol/interface), not concrete implementations.
• Data layer — repository implementations. OrderRepositoryImpl implements OrderRepository from domain. Knows about Retrofit, Room, UserDefaults. The ViewModel doesn’t know where data comes from—network or cache.
• Presentation layer — ViewModel + View. Knows about Domain, not Data.

Dependency rule: dependencies point inward only. Domain depends on nothing. Data and Presentation depend on Domain.

Presentation → Domain ← Data

This allows swapping implementations: tests use an in-memory repository instead of network, the interface remains the same.

Practical caveat: Clean Architecture adds files and layers. For small apps, this is overhead. It’s justified starting from ~15 features and teams of 3+ developers.

BLoC for Flutter: Predictable State Flow

BLoC (Business Logic Component) is the standard pattern in the Flutter community. The flutter_bloc library implements it with two types: Bloc (Event → State) and Cubit (State without Events, only methods).

Bloc processes Event and emits a new State via on<EventType> handlers. State is immutable—a new object for each change. BlocBuilder re-renders only the part of the tree where state changed.

// Event
abstract class CartEvent {}
class AddItemToCart extends CartEvent {
  final String productId;
  AddItemToCart(this.productId);
}

// State
abstract class CartState {}
class CartLoaded extends CartState {
  final List<CartItem> items;
  CartLoaded(this.items);
}

// Bloc
class CartBloc extends Bloc<CartEvent, CartState> {
  CartBloc(this._cartRepository) : super(CartLoaded([])) {
    on<AddItemToCart>(_onAddItem);
  }

  Future<void> _onAddItem(AddItemToCart event, Emitter<CartState> emit) async {
    final current = state as CartLoaded;
    final updated = await _cartRepository.addItem(event.productId);
    emit(CartLoaded(updated));
  }
}

The advantage of BLoC is testability. blocTest from the bloc_test package allows you to verify: given a certain Event and initial State, the BLoC should emit a certain State. No UI, no mocks for the Flutter framework.

VIPER: For Large iOS Projects

VIPER (View, Interactor, Presenter, Entity, Router) is the strictest separation of responsibilities for iOS. Each component has a protocol and concrete implementation.

• View — UI only, delegates everything to Presenter
• Interactor — business logic, network and data operations
• Presenter — mediator between View and Interactor, formats data for View
• Entity — data models (pure structures)
• Router — navigation between modules

Each module (screen or feature) is a separate VIPER module. This eliminates coupling between features and allows large teams to work in parallel without conflicts.

The cost: many files, many protocols. Boilerplate is generated via Sourcery or custom Xcode templates. VIPER is justified for apps with 10+ developers and 50+ screens.

TCA (The Composable Architecture)

TCA by Point-Free is a more modern alternative to VIPER for iOS/macOS. Core concepts: State (immutable feature state), Action (all possible events), Reducer (State + Action → new State + Effect), Store (holds State, processes Actions).

Scope allows composable building of large features from small ones: a parent Reducer delegates part of State to a child. Each feature is tested in isolation via TestStore with precise control over Effects.

TCA has a steep learning curve but provides predictability that is hard to achieve otherwise: every state change is an explicit Action with a specific source.

Which Pattern to Choose for Your Project?

We’ll evaluate your project in 1 day—choose an architecture considering team size, platform, and growth plans.

There is no universal answer. Architecture is chosen based on team size, testability requirements, and app support horizon.

What Components Are Included in Our Architecture Work?

• Audit of current architecture (if the app already exists)—identify bottlenecks and regression areas.
• Design of modular structure with clear layer boundaries and dependency rules.
• Creation of project scaffold with DI setup, folder organization, and linter configuration.
• Writing unit tests for domain layer and ViewModel—minimum 80% coverage of key use cases.
• Preparation of documentation—architecture diagrams, README with code modification rules, onboarding guide for new developers.
• Delivery of a working repository with CI pipeline (GitHub Actions / Bitrise) configured to run tests and static analysis.

All this is included in the design cost. Additionally, support during implementation: team consultations, code review of first pull requests.

How Does Lack of Architecture Affect Development Speed?

Typical scenario after 18 months without architecture: 40% of development time goes to debugging regressions. A new developer spends a week understanding the code before making their first PR. Tests aren’t written “because it’s hard to mock.” Adding a new feature requires understanding half the codebase.

Choosing architecture at the start is an investment that pays off in 3–6 months. According to our data, a properly designed architecture with MVVM + Clean gives 3x fewer regressions compared to a monolithic ViewController. And the cost of implementation is recouped in 2–3 sprints.

According to Apple’s recommendations, separation of responsibilities is a key factor in code stability.

Why Trust Our Team with Architecture?

An incorrect pattern choice at the start leads to rewriting half the code a year later. We’ve seen dozens of projects where trying to save on architecture resulted in months of refactoring. With over 10 years of commercial development experience and work on apps from 1 to 50 developers, we help avoid common mistakes:

• Overengineering for a simple MVP (we assign MVVM, not VIPER).
• Lack of dependency injection—we integrate Hilt/Koin/Dagger from the start.
• Ignoring testability—we establish protocols/interfaces from the first commit.

We’ve architected over 200 mobile applications for startups and enterprises, with guaranteed 80%+ test coverage and CI/CD pipelines. Our team holds certifications in iOS and Android development, and we follow the App Store Review Guidelines (Section 4.2/5.1) to ensure smooth store approvals.

Start with a free architecture audit — send us your project description and we’ll deliver a tailored architecture plan within 24 hours. Reach out via Telegram or email to get started.