Skip to main content

11 docs tagged with "api-design"

View all tags

API Contract Governance, Linting & Testing

Run an API program at scale - design-first vs code-first, Spectral linting, oasdiff breaking-change gates, Prism mocks, OpenAPI Generator interfaces, Pact consumer-driven contracts, Schemathesis fuzzing, CI pipeline, API catalog and review process.

API Design, OpenAPI & Swagger Deep Dive

Senior-level API design handbook - OpenAPI/Swagger, contract-first workflow, naming conventions, resource modeling, errors, pagination, versioning, idempotency, security, governance and interview preparation.

API Naming Conventions & Style Guide

Comprehensive REST API naming conventions - URLs, query parameters, JSON fields, headers, enums, IDs, dates, money, operationIds and schema names - compared across Google AIP, Microsoft, Zalando, and Stripe guidelines, with a searchable rule book.

API Security Checklist (OWASP API Top 10 2023)

OWASP API Security Top 10 (2023) mapped to concrete Spring Boot and OpenAPI controls - BOLA, broken authentication, mass assignment, unrestricted resource consumption, SSRF, security misconfiguration, plus OAuth scopes in specs and gateway policy.

API Versioning, Breaking Changes & Deprecation

How to evolve APIs safely - catalog of breaking and non-breaking changes, versioning strategies (URI, header, media type, date-based), tolerant reader, expand-contract, deprecation with Sunset headers, and sunset governance.

OpenAPI & Swagger Fundamentals

Deep dive into the OpenAPI 3.x specification - document structure, components, JSON Schema 3.1, polymorphism with oneOf and discriminator, security schemes, callbacks and webhooks, Swagger UI/Editor/Codegen tooling, and common spec pitfalls.

Resource Modeling & HTTP Semantics

Senior API design - modeling resources from domain use-cases, PUT vs PATCH (merge patch vs JSON Patch), safe and idempotent methods, status code selection, conditional requests with ETag, long-running operations, bulk endpoints, and hypermedia trade-offs.

Spring Boot + springdoc-openapi (Code-First Swagger)

Generate and govern OpenAPI specs from Spring Boot 3 with springdoc-openapi - annotations, groups, security schemes, polymorphism, Pageable, global error responses, customizers, exporting the spec in CI, and production pitfalls.