Project brief — Service

Versioned REST API

Design a REST API from resources up: write the specification first, implement against it, then version it without breaking existing clients.

Beginner
Type
Service
Difficulty
Beginner
Duration
2 weeks
Milestones
2

Requirements

Non-negotiable. A submission that skips one of these is returned, not graded.

  • R1OpenAPI specification written before implementation
  • R2Consistent error shape with machine-readable codes
  • R3Pagination, filtering and idempotency where they belong
  • R4A v2 change shipped without breaking v1 consumers

Timeline

2 weeks, staged

  1. Week 1

    Design

    Resource modelling, spec authoring and review before any code.

  2. Week 2

    Implement & version

    Handlers, contract tests and the versioned change.

Stack

Node.jsPostgresOpenAPI

Deliverables

  • OpenAPI spec
  • Running service
  • Contract tests
  • Migration guide

Reviewed on

  • Resource design
  • Spec accuracy
  • Backwards compatibility
  • Test quality

Take this brief

Every brief is reviewed by a practitioner. You get written feedback on code, documentation and the decisions behind both.

Request a review slot