Zum Hauptinhalt springen
Friedrichs IT Signet

OpenAPI

Spezifikationsdesign, Tooling, Dokumentation und Change Management

OpenAPI ist das Rückgrat moderner REST-API-Gestaltung und Dokumentation. Dieser Bereich fokussiert praktische Nutzung: contract-first Workflows, Dokumentationsgenerierung, Versionierung, Changelogs und Techniken, die Spezifikation, Implementierung und Kommunikation mit Konsumenten sauber ausrichten.

Beiträge

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
Internal API Documentation with Docusaurus

Internal API Documentation with Docusaurus

Docusaurus is great for public developer portals, but what if you want to keep your API documentation internal?

8 Min. Lesezeit
Building API Documentation with Docusaurus

Building API Documentation with Docusaurus

Technical documentation is more than just a README - it’s a product in itself. For APIs, a clear and interactive documentation experience can make or break adoption.

5 Min. Lesezeit