Seminar Kong Insomnia für API Design, Testing und Debugging

Inhaltsverzeichnis

• Zielbild und Einsatzszenarien
• Thematische Inhalte
• Praxisleitfaden
• Übungsdesign
• Zielgruppe und Voraussetzungen
• Betriebs- und Qualitätskriterien

Zielbild und Einsatzszenarien

Kapitelübersicht: Einordnung, typische Nutzungsmuster und Abgrenzung des Themenbereichs.

Insomnia wird als Werkzeug für API-Design, Debugging und Testautomatisierung eingesetzt. Das Seminar verbindet manuelle Entwicklungsarbeit mit wiederholbaren Prüfungen im API-Lebenszyklus.

• Erstellung und Pflege von OpenAPI-Spezifikationen.
• Strukturierte Requests für Entwicklungs-, Test- und Produktionsumgebungen.
• Debugging von Authentifizierung, Headern, Payloads und Fehlerantworten.
• Automatisierte API-Tests über CLI-nahe Ausführung.

Thematische Inhalte

Kapitelübersicht: Technische Bausteine, Konzepte und Konfigurationsbereiche.

• Workspaces, Documents, Collections und Umgebungskonzepte.
• OpenAPI-Design, Import, Export und Linting-Grundlagen.
• Authentifizierungshelfer, Variablen und sichere Parameterverwaltung.
• Tests, Assertions, Skripte und Wiederholbarkeit.
• Inso CLI für Testausführung und Pipeline-Anbindung.
• Zusammenspiel mit Kong Gateway und API-Produktveröffentlichung.

Praxisleitfaden

Kapitelübersicht: Schrittfolge für eine nachvollziehbare Umsetzung im Labor- oder Projektkontext.

1. Workspace und API-Dokument für ein Beispielprojekt strukturieren.
2. OpenAPI-Spezifikation importieren oder erstellen.
3. Requests aus der Spezifikation generieren und Umgebungsvariablen anlegen.
4. Authentifizierungsdaten für mehrere Zielumgebungen verwalten.
5. Tests mit Assertions erstellen und Fehlerantworten prüfen.
6. Testausführung über CLI vorbereiten und Testbewertung definieren.

Übungsdesign

Kapitelübersicht: Laboraufgaben, Kontrollpunkte und prüfbare Arbeitspakete.

• OpenAPI-Design mit mehreren Umgebungen.
• Request Collection für geschützte Gateway-Routes.
• Test Suite mit Positiv- und Negativfällen.
• CLI-Testlauf als Baustein für eine CI-Prüfung.

Zielgruppe und Voraussetzungen

Kapitelübersicht: Rollenprofil, benötigtes Vorwissen und fachlicher Einstiegspunkt.

Zielgruppe: API-Entwickler, Tester, technische Analysten, API Product Owner und DevOps-nahe Entwicklungsteams.

Voraussetzungen: Grundlagen zu HTTP, REST, JSON und OpenAPI sind hilfreich.

Betriebs- und Qualitätskriterien

Kapitelübersicht: Nachvollziehbarkeit, Wartbarkeit und robuste Einordnung in Plattformprozesse.

Die Übungen fördern saubere Spezifikationen, reproduzierbare Requests und testbare API-Verträge.