Training Agenda

REST API Design
& OpenAPI

REST is widely used but rarely used correctly. Resource modeling, HTTP semantics, versioning, error formats, and pagination each have well-established patterns — but teams often drift from them under deadline pressure and end up with APIs that are inconsistent, hard to evolve, and painful to integrate against. This training covers REST API design from first principles through OpenAPI specification, with practical examples in Spring Boot.

1 day On-site, remote, or hybrid Up to 20 participants German or English
What We Cover
Design APIs that last and documents that work
Day 1

REST Design Principles & OpenAPI Specification

  • REST constraints and what actually makes an API RESTful
  • Resource modeling: identifying nouns, collection vs singleton, sub-resources
  • HTTP methods: GET, POST, PUT, PATCH, DELETE — correct semantics
  • Status codes: 2xx, 4xx, 5xx — and the ones teams always get wrong
  • Request and response design: consistent naming, field selection
  • Error format: RFC 9457 Problem Details — machine-readable, actionable
  • Versioning strategies: URI, header, content negotiation — trade-offs
  • Pagination: offset, cursor, keyset — choosing the right pattern
  • OpenAPI 3.1: describing paths, parameters, request bodies, responses
  • Schema design: reuse with $ref, oneOf/anyOf for polymorphism
  • Springdoc with Spring Boot: auto-generating and customizing the spec
  • API-first workflow: generate server stubs and client SDKs from the spec
  • Spectral linting: enforcing API style guides automatically
Learning Outcomes
What your team walks away with

API designers who build contracts that are consistent, evolvable, and easy to integrate against — with an OpenAPI spec that serves as living documentation.

Book the REST API Design training

A focused one-day course — works well standalone or as part of a backend API development track with Spring Boot.

Get in touch