REST API for Web Apps: Design and Implementation

We specialize in REST API development and follow best practices of RESTful API design so you don't have to rewrite it in six months. A typical mistake is confusing REST with RPC, making endpoints unintuitive and clients brittle. Another common issue is inconsistent response formats — one endpoint returns {data}, another {result}, forcing clients to write custom parsers. Our certified team has designed dozens of APIs for SaaS platforms handling millions of requests daily, and we know how to avoid these pitfalls. Below we cover key principles, pagination, versioning, API error handling, and show an example implementation in Laravel API. If you need a robust REST API built from scratch, contact us for a free project evaluation. Our basic CRUD API package costs $4,999 and includes 10 endpoints; this approach saves clients an average of $20,000 annually in maintenance costs.

Key Principles of REST API

Resource-oriented design: URLs identify resources, HTTP methods define actions. Here's typical CRUD for articles:

GET    /api/v1/articles          — list articles
POST   /api/v1/articles          — create article
GET    /api/v1/articles/42       — get article with id=42
PUT    /api/v1/articles/42       — full update
PATCH  /api/v1/articles/42       — partial update
DELETE /api/v1/articles/42       — delete
GET    /api/v1/articles/42/comments — comments for article

Stateless: each request contains all information needed for processing — no session state between requests. Uniform response format: for success return { "data": {...} }, for list { "data": [...], "meta": {...} }, for error { "error": { "code": "...", "message": "..." } }. This simplifies integration and debugging. According to Wikipedia, REST relies on a uniform interface, which we strictly follow.

Which HTTP Status Codes to Use?

Proper code usage is the foundation of the contract:

Which Pagination to Choose for a High-Load API?

Offset pagination is simple and allows jumping to any page, but it is 95% slower on datasets over 1 million rows due to OFFSET in SQL. Keyset pagination (e.g., after_id) combines speed and simplicity, requiring only unique sorting. Compare them:

For most applications, we recommend keyset pagination: GET /api/articles?after_id=42&limit=20. It is an order of magnitude faster than offset for millions of records and does not shift when new data is added.

Filtering, Sorting, and Including Relationships

Example of a complex request:

GET /api/articles?status=published&author_id=5&created_after=2023-01-01&sort=created_at&order=desc&include=author,tags

The include parameter pulls related resources, reducing the number of requests (N+1 problem). We use Laravel with() with whitelist validation. Such filtering reduces database queries by 2-3x on typical pages, and with a thousand concurrent users saves up to 40% of server resources. In one SaaS platform handling 1 million requests/day, we implemented keyset pagination and eager loading, cutting API response time by 40%.

API Versioning: URL or Headers?

URL versioning (/api/v1/) is the most explicit and simple. An alternative is the Accept header: Accept: application/vnd.app.v2+json. We recommend URL because it's clear to all developers and requires no client configuration. If multiple versions need to be supported simultaneously, we use middleware that routes requests to the appropriate controller. This allows parallel development of v2 without breaking v1.

Example Implementation in Laravel API

// routes/api.php
Route::prefix('v1')->middleware('auth:sanctum')->group(function () {
    Route::apiResource('articles', ArticleController::class);
    Route::get('articles/{article}/comments', [CommentController::class, 'index']);
});

// ArticleController
public function index(IndexArticleRequest $request)
{
    $articles = Article::query()
        ->when($request->status, fn($q, $v) => $q->where('status', $v))
        ->with($request->include ?? [])
        ->paginate($request->per_page ?? 20);

    return ArticleResource::collection($articles);
}

Process of Building a REST API Turnkey

Here's how we work:

1. Requirements analysis — study business logic, entities, and use cases.
2. Endpoint design — create OpenAPI specification, agree with you.
3. Implementation — write code on chosen framework (Laravel, Django, Express — any).
4. Testing — cover with unit and integration tests (coverage ≥85%).
5. Documentation — keep OpenAPI up-to-date, prepare Postman collection.
6. Deployment — set up CI/CD, monitoring, and deliver operations documentation.

What's Included

• OpenAPI (Swagger) documentation describing all endpoints.
• Implementation on chosen framework.
• API authentication (JWT, OAuth2, API keys) — API authentication guaranteed.
• Pagination, filtering, and API error handling.
• Integration tests (PHPUnit/Pytest).
• Postman collection for testing.
• Deployment and operations documentation.
• 1 month support after delivery.

Timelines and Pricing

Development timeline for a typical CRUD API (10–20 endpoints) ranges from 1 to 2 weeks. Pricing is calculated individually after scope evaluation, with basic APIs starting at $4,999. Our REST API development approach reduces maintenance costs by up to 15% and accelerates third-party integration. Order REST API development — contact us for a project evaluation. We'll help design an API you won't have to rewrite.

API Development with REST, GraphQL, WebSocket, and tRPC

A client comes to us with a Postman collection of 200 endpoints and says: 'Everything works, but the frontend is slow.' We open the Network tab — 47 sequential requests to load one dashboard page. Each one waits for the previous. This is not a server speed issue — it's an API architecture problem. With 10 years on the market, we've redesigned dozens of such integrations, and we guarantee: the right protocol and contract solve the problem at its root.

When REST stops being enough

REST works well for simple CRUD operations. But as soon as a mobile app appears alongside the web interface, over-fetching begins: the mobile app requests /api/users/123 and gets a 4KB object, but only needs name and avatar. Multiply that by a list of 50 users — 200KB traffic instead of 8KB.

GraphQL solves this with selection sets. The client describes exactly the fields it needs, and the server returns only those. On a project with React Native + Next.js, we migrated from REST to Apollo Server: payload size on the main screen dropped from 340KB to 28KB — a 92% traffic savings. Our certified engineers confirm: the typical pain when adopting GraphQL is N+1 query. A resolver for the author field on a post calls SELECT * FROM users WHERE id = ? for each post in the list. On a page with 20 posts — 21 database queries. Solved with DataLoader — it batches queries and turns them into one SELECT * FROM users WHERE id IN (...).

What is tRPC and how is it better than REST/GraphQL?

If the entire stack is TypeScript (Next.js + Node/Bun), tRPC removes a whole layer of problems. You define a procedure on the server — the client gets full type-safety automatically, without code generation and without Swagger. Renamed a field in the Zod schema — TypeScript highlights all places on the frontend where it's used. tRPC reduces code by 2 times compared to REST + Swagger + openapi-typescript: no need to maintain a separate specification and generate types — everything is inferred from runtime validators. However, tRPC is not suitable if the API is consumed by third-party clients or mobile apps in other languages — in such cases we use GraphQL or REST with OpenAPI specification.

WebSocket and real-time: when SSE, when WS?

HTTP polling every 5 seconds is an illusion of real-time with up to 5 seconds delay and useless server load. For chats, live notifications, collaborative editing — WebSocket or Server-Sent Events. SSE is a one-way stream from server to client, works over ordinary HTTP, automatically reconnects. Suitable for notifications, data streaming, progress bars. WebSocket is bidirectional, needed for chats and collaborative features. Experience shows: 80% of 'real-time' tasks are solved with SSE, not WebSocket — fewer infrastructure complexities.

A typical mistake: opening a WebSocket connection for each page component. On one project, the dashboard opened 12 parallel WS connections. The correct approach is one connection manager at the application level, subscriptions through it. In our work results, we always transfer the connection scheme and a ready solution.

Swagger / OpenAPI as a contract

Documentation written after the fact becomes outdated the day after release. We write the OpenAPI 3.1 specification before development starts; it becomes the contract between frontend and backend. The frontend generates types via openapi-typescript, the backend validates incoming data using generated schemas. Contract deviation from implementation is caught on CI, not during review. For Laravel — l5-swagger or dedoc/scramble. For Node.js — @fastify/swagger or Zod + zod-to-openapi.

How to properly authenticate an API?

JWT with long-lived access tokens without rotation is a source of problems when compromised. The correct scheme: access token for 15 minutes, refresh token for 30 days with rotation on each use. Refresh token stored in an httpOnly cookie, access token in memory (not in localStorage). For inter-service communication — API Keys with scope limitations or mTLS. OAuth 2.0 with PKCE for public clients (SPA, mobile).

How to handle versioning and backward compatibility?

Breaking changes in an API without versioning break clients. Three approaches we use in projects:

We guarantee backward compatibility through automated checks (oasdiff) on CI.

How we develop APIs: step-by-step plan

1. Analysis — audit of current integrations, data schema compilation, protocol selection (REST/GraphQL/tRPC/WebSocket).
2. Contract design — OpenAPI or SDL (GraphQL) before the first line of code.
3. Development — implementation per contract, unit tests for each endpoint.
4. Load testing — k6: 500 virtual users, 10 minutes, p95 latency ≤ 200ms.
5. Deployment — CI/CD with backward compatibility check, automatic documentation publication.
6. Team training — handover of Postman collection or Playground, connection instructions.

What is included (deliverables)

• OpenAPI 3.1 specification (or SDL for GraphQL).
• Generated client types for TypeScript / Dart / Kotlin.
• Set of automated tests covering all endpoints (unit + integration).
• Load tests (k6) and report (p50/p95/p99 latency, RPS).
• Documentation in Swagger UI / Redoc / GraphiQL.
• Team training (2–4 hour workshop).
• Support for 30 days after delivery (per contract).

Our experience

• 10+ years in the API development market.
• 200+ completed projects (REST, GraphQL, WebSocket, tRPC).
• 50+ certified engineers (AWS, Kubernetes, API Design).
• Traffic savings averaging 85% when migrating from REST to GraphQL for mobile apps.
• 100% backward compatibility — not a single broken client in the last 3 years.

Timeline

API development for a typical SaaS project with 30–50 endpoints: from 3 to 8 weeks depending on business logic complexity and number of external integrations. Migration of an existing REST API to GraphQL: from 2 to 6 weeks. Adding a WebSocket layer to an existing backend: from 1 to 3 weeks. Cost is calculated individually after an audit. Get a consultation — contact us to discuss your project.