Dev API

Develop an API

Objective

Create well-structured, documented and testable APIs.

Instructions

1. Define the contract

Before coding, define:

• Endpoint (URL, HTTP method)
• Request (body, query params, headers)
• Response (status codes, body)
• Possible errors

2. RESTful structure

GET    /resources          → List (with pagination)
GET    /resources/:id      → Detail
POST   /resources          → Create
PUT    /resources/:id      → Full update
PATCH  /resources/:id      → Partial update
DELETE /resources/:id      → Delete

3. Standard response format

// Success
{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 100
  }
}

// Error
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Email is required",
    "details": [
      { "field": "email", "message": "Required" }
    ]
  }
}

4. Input validation

// With Zod
const createUserSchema = z.object({
  email: z.string().email(),
  name: z.string().min(2).max(100),
  role: z.enum(['user', 'admin']).default('user')
});

// In the handler
const data = createUserSchema.parse(req.body);

5. OpenAPI documentation

paths:
  /users:
    post:
      summary: Create a user
      tags: [Users]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUser'
      responses:
        '201':
          description: User created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '400':
          $ref: '#/components/responses/ValidationError'

6. API tests

describe('POST /api/users', () => {
  it('should create user with valid data', async () => {
    const response = await request(app)
      .post('/api/users')
      .send({ email: 'test@example.com', name: 'Test' })
      .expect(201);

    expect(response.body.success).toBe(true);
    expect(response.body.data.email).toBe('test@example.com');
  });

  it('should return 400 for invalid email', async () => {
    const response = await request(app)
      .post('/api/users')
      .send({ email: 'invalid', name: 'Test' })
      .expect(400);

    expect(response.body.error.code).toBe('VALIDATION_ERROR');
  });
});

7. tRPC (type-safe TypeScript)

For a full-stack TypeScript monorepo, tRPC gives end-to-end type safety with no codegen.

// Server: initTRPC + Zod-validated procedures
const t = initTRPC.context<Context>().create({ transformer: superjson });
const protectedProcedure = t.procedure.use(({ ctx, next }) => {
  if (!ctx.session) throw new TRPCError({ code: 'UNAUTHORIZED' });
  return next({ ctx: { ...ctx, user: ctx.session.user } });
});

export const userRouter = t.router({
  list: t.procedure.input(z.object({ cursor: z.string().nullish() }))
    .query(({ input, ctx }) => ctx.userService.paginate(input)),      // cursor-based pagination
  create: protectedProcedure.input(createUserSchema)
    .mutation(({ input, ctx }) => ctx.userService.create(input)),
});

• Build the context (prisma, session, user); use protectedProcedure for authenticated operations.
• Group routers per domain (public queries / protected queries / mutations).
• Client: httpBatchLink + transformer + provider; hooks useQuery, useMutation, useInfiniteQuery.
• IMPORTANT: always validate inputs with Zod; NEVER expose sensitive data in public queries.

8. API versioning

Let the API evolve while keeping existing clients working. URL Path versioning (/v1/, /v2/) is recommended for most cases.

• Choose the strategy: URL Path (default), Query Param, Header, or Content Negotiation.
• Structure the code: versioned API layer, non-versioned Service layer.
• Classify changes: additive = safe (same version), breaking = new version.
• Deprecation timeline: Active → Deprecated → Sunset → Off, with Deprecation, Sunset and Link (successor-version) headers.
• Document every breaking change with a migration guide; monitor per version (requests, clients, errors, latency).
• IMPORTANT: never remove a version without a deprecation period; NEVER make breaking changes in a minor version.

API Checklist

• RESTful endpoint
• Input validation (Zod/Joi)
• Centralized error handling
• Appropriate status codes
• OpenAPI documentation
• Integration tests
• Rate limiting (if public)
• Authentication (if private)

Expected output

## API: [Endpoint name]

### Endpoint
`POST /api/v1/resources`

### Request
```json
{
  "field1": "string",
  "field2": 123
}

Response (201)

{
  "success": true,
  "data": { ... }
}

Errors

## Rules

- IMPORTANT: Always validate inputs
- IMPORTANT: Document with OpenAPI
- YOU MUST return appropriate HTTP status codes
- NEVER expose internal errors in production