Skip to main content
Friedrichs IT Signet

API Documentation

Developer documentation that supports adoption and operations

Good API docs reduce onboarding time and integration risk. Here I cover portal UX, references, examples, SDK guidance, and toolchains such as Docusaurus, Redoc, and Swagger UI with a focus on maintainability.

Articles

API Changelogs with Docusaurus

API Changelogs with Docusaurus

Add versioned OpenAPI snapshots, CI-based diffs, and a practical changelog flow to Docusaurus so API consumers can understand and migrate releases safely.

10 Min. Lesezeit
AsyncAPI – Documenting Message-Driven APIs

AsyncAPI – Documenting Message-Driven APIs

How AsyncAPI complements OpenAPI for documenting asynchronous message-driven APIs, with a practical example, diagram, CI/testing tips, and documentation options.

4 Min. Lesezeit
OpenAPI Specification 3.2 Released – What’s New?

OpenAPI Specification 3.2 Released – What’s New?

OpenAPI 3.2 brings path templating, new HTTP methods, streaming support, and richer documentation features.

5 Min. Lesezeit