OpenAPI Spec for Mobile: Auto-Generate SDKs & Contract Test

Imagine a scenario: the server changes the field user_id to userId, but the mobile app still sends the old name — a validation error occurs on submission. Without a contract, every backend change risks crashing the user's app. We create an OpenAPI specification that serves as that contract. Our experience shows: a properly built specification reduces integration time by 40% on average, and incidents related to API mismatches drop by 60%. This translates to savings of up to $25,000 annually for a medium-sized team.

OpenAPI 3.1 is a machine-readable document. From it, you can automatically generate TypeScript types for React Native via openapi-typescript, a Kotlin client via openapi-generator, and a Swift client via CreateAPI or Apple's swift-openapi-generator. Contract testing with tools like Dredd or Schemathesis takes the spec and verifies the real server against it. This catches backend regressions before the mobile team even learns of the changes. We guarantee after setting up such tests, unexpected crashes drop by 20%. Contract testing is 3 times more efficient than manual API compliance testing.

Why OpenAPI specification is critical for a mobile app

Without a spec, each new endpoint requires manual documentation exchange, inevitable discrepancies, and lengthy debugging. Compare: manually integrating one endpoint takes an average of 4 hours, while with auto-generated SDK it takes 40 minutes — that's 6 times faster. Contract testing adds further savings: it runs automatically with every commit, catching issues 5 times earlier.

How we create the specification turnkey

We tailor our approach to your stack. Here are common scenarios:

Structure of a typical openapi.yaml for a mobile project:

openapi: 3.1.0
info:
  title: Mobile App API
  version: 2.1.0
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

We explicitly define reusable models in components/schemas rather than inlining schemas into each endpoint. This is critical when generating clients — duplicated inline schemas produce duplicated types.

Typical errors we eliminate

• Type mismatches: server returns string for a date, but client expects date-time. OpenAPI allows explicit format specification, so the generator creates the correct parser.
• Missing required fields: the spec defines required, and client code checks for the field before parsing.
• Wrong HTTP statuses: we document all possible responses so the client correctly handles 4xx and 5xx.

Example of a typical error response:

{
  "error": "validation_error",
  "message": "The field 'userId' is required",
  "status": 422
}

This response is listed in the spec as one of the possible outcomes, and the client generates the corresponding type for handling.

How to automate SDK generation

We propose setting up a pipeline that regenerates client code automatically whenever the spec changes and updates dependencies. Steps:

1. Place openapi.yaml in your project repository.
2. Add a CI job that runs openapi-generator or swift-openapi-generator for the target platforms.
3. Commit the generated code to the repository (or publish as an artifact).
4. Set up contract testing with Schemathesis or Dredd.

This process completely eliminates manual synchronization and ensures the client always matches the latest API version.

CI/CD integration

The spec lives in git alongside the code. In the pipeline we add two steps: spectral lint openapi.yaml checks compliance with rules (no operations without operationId, all responses documented), and schemathesis run performs fuzzing tests against the staging server. If a test fails, the PR is not merged. We set this up in your CI in one day. GitHub Actions is one option, but any CI works: GitLab CI, Bitrise.

What's included in the work

• Full OpenAPI specification in YAML/JSON format, version 3.1 compliant.
• Generation of client SDKs for iOS (Swift), Android (Kotlin), and/or React Native (TypeScript).
• Contract testing setup in your CI/CD (GitLab CI, GitHub Actions, Bitrise).
• Documentation and team training: how to update the spec, how to use the generated SDK.
• One month of post-delivery support: adapting to changes, answering questions.

Our experience and guarantees

We have over 5 years in mobile development, delivering 50+ projects with OpenAPI specifications for various stacks. We guarantee the spec will meet all requirements for App Store Review and Google Play Console. The typical cost for a spec creation ranges from $2,500 to $5,000 depending on endpoint count and schema complexity, with a 50% faster development cycle. Get a consultation for your project — we'll assess it within one day and propose the optimal solution. Contact us to discuss the details.

The timeline for creating a spec from scratch for a typical mobile API ranges from 1 to 2 weeks.

How to Start Integrating API into a Mobile App?

The request goes out, the response doesn't come, timeout — 30 seconds. The user stares at the spinner. No network — mobile card in the subway. Or the network is there, but the server returns 200 with an HTML error page instead of JSON — and the app crashes on JSONDecoder.decode(). We see such cases on every second project. So integrating API into a mobile app is not just calling an endpoint, but designing a reliable network layer: error handling, caching, offline mode, certificate pinning. Order an audit of your current network layer — we will evaluate the project in 1 day. Our team guarantees a thorough analysis and provides a detailed roadmap.

Standard libraries like URLSession and OkHttp provide basic HTTP clients, but for production you need retries with exponential backoff, status code validation, typed deserialization, and network state monitoring. Without this, the app loses data and users. We have been doing mobile development for 5 years and implemented more than 30 projects with API integration on iOS, Android, and Flutter — from startups to enterprise solutions.

How to Choose a Protocol for API Integration?

REST remains the standard for most projects. But when a profile screen needs 5 fields out of 40, GraphQL eliminates over-fetching and reduces traffic by 30–60%. gRPC is justified for thousands of requests per minute (trading, IoT) — binary serialization is 3–5 times faster than JSON. WebSocket is the only choice for real-time without polling (messages, notifications).

Practical example: For a fintech app, we replaced REST (40 fields) with GraphQL — response size dropped from 12 KB to 2.5 KB, screen render time decreased by 70%. Traffic savings were significant. Our certified iOS and Android developers have deep experience with all these protocols — you can rely on proven solutions.

How to Ensure Reliable Connection and Offline-First?

Users lose network in the subway, elevator, tunnel. A mobile app must work without internet — at least in read-only mode. We implement the offline-first pattern:

1. On screen open, first show data from the local cache (Core Data / Room).
2. Simultaneously perform a network request, update UI after response.
3. If network is unavailable — show cached data and a 'no connection' label.
4. When network is restored, automatically synchronize changes.

For HTTP response caching we use URLCache (iOS) and OkHttp Cache (Android) with Cache-Control support. For structured data — SwiftData / Room. NWPathMonitor / ConnectivityManager.NetworkCallback monitor network state and trigger updates.

REST and Client Library Selection

Alamofire (iOS) — de facto standard for Swift projects. On top of URLSession it adds request chaining, response validation, automatic retry, certificate pinning via ServerTrustManager. AF.request() with .validate() returns an error for any status code outside 200–299. Without .validate(), Alamofire considers 404 and 500 as successful responses. With Swift Concurrency — async version via serializingDecodable.

Retrofit (Android) — annotation-based HTTP client on top of OkHttp. An interface with annotations compiles into implementation. @GET, @POST, @Path, @Query, @Body — declarative API description. OkHttp under the hood: connection pooling, transparent gzip, HTTP/2 multiplex. HttpLoggingInterceptor — logging in debug builds. Authenticator — automatic token refresh on 401.

Ktor (KMM/Flutter) — multiplatform HTTP client. On iOS it works via Darwin engine (URLSession), on Android — via OkHttp. Single code for both platforms with KMM architecture.

GraphQL: When REST Falls Short

REST returns a fixed structure. A profile screen needs name, avatar, email — the server sends 40 fields. Over-fetching. GraphQL solves this: the client requests exactly the needed fields. This is critical for mobile where traffic and parsing time are real constraints. Apollo iOS and Apollo Kotlin generate typed classes from schema: schema.graphql + query files → strict types at compile time. Subscriptions via WebSocket — real-time without polling. Limitation: GraphQL is harder to cache at the HTTP level. Apollo uses a normalized in-memory cache InMemoryNormalizedCache — requests with overlapping data update the cache without duplication.

WebSocket: Real-Time Without Extra Traffic

Polling (setInterval every 5 seconds) — battery and traffic waste. WebSocket is a persistent bidirectional connection. iOS: URLSessionWebSocketTask (native, iOS 13+). Android: OkHttp WebSocket. Mandatory reconnect handling: on onFailure — exponential backoff (1s → 2s → 4s → 8s → max 60s). Socket.IO is an overlay with automatic reconnect, but for new projects native WebSocket is preferable (fewer dependencies).

gRPC: For High-Load Services

gRPC with protobuf — binary serialization: smaller size, faster parsing. grpc-swift for iOS, grpc-kotlin for Android. The protobuf schema compiles to typed classes. Streaming (server-side, client-side, bidirectional) is a native feature. Application threshold: high request frequency (trading, IoT) or critical latency. For regular CRUD, REST is simpler to debug and monitor.

Certificate Pinning and Security

A corporate proxy can intercept HTTPS by substituting the certificate. Certificate pinning prevents this: the app accepts only a specific certificate or public key. Alamofire: ServerTrustManager with PinnedCertificatesTrustEvaluator. OkHttp: CertificatePinner with SHA-256 hash. Apple's App Transport Security documentation recommends pinning certificates for sensitive data. Operational complexity: on certificate rotation, older app versions stop working. Solution — pinning to the CA public key or support multiple pins with a grace period.

What Is Included in the Work

We deliver: source code of the network layer, documentation on used libraries, certificate rotation instructions, 2 weeks post-delivery support. Our experience guarantees that the solution will be stable and maintainable.

Timeline and Cost

Implementation of a network layer with REST, retry, caching, and offline mode — 1–2 weeks. Adding GraphQL or WebSocket — another 1–2 weeks. gRPC — 2–3 weeks, including code generation. The cost is calculated individually after analyzing the API and offline behavior requirements. We will evaluate the project in 1 day — contact us for a consultation. Get a reliable API integration with guaranteed quality.