Bitte wählen Sie die Bereiche, die Sie exportieren möchten:
Schulung OpenAPI Specification: APIs design-first definieren, dokumentieren und generieren
Professional API Design: Von der Schema-Definition zum Client-SDK
Schulungsformen
Inhouse-/Firmenschulung
- 2 Tage - anpassbar
- Termin nach Wunsch
- In Ihrem Hause oder bei der GFU
- Preis nach Angebot
- Lernumgebung in der Cloud
- Inhalte werden auf Wunsch an die Anforderungen Ihres Teams angepasst.
Beschreibung
Unternehmen profitieren von einer drastisch verbesserten Kommunikation zwischen Teams, der Vermeidung von "Broken APIs" durch automatisierte Validierung und einer massiv verkürzten Time-to-Market durch parallele Entwicklung und automatisiertes Tooling.
Schauen Sie sich auch diese KI Weiterbildungen an.
Schulungsziel
Die Teilnehmenden erlernen die Erstellung und Validierung von API-Spezifikationen nach dem OpenAPI 3.1 Standard. Ziel ist es, komplexe Datenmodelle und Endpunkte präzise zu definieren, automatisierte Linting-Regeln mit Spectral zu implementieren und Client-SDKs sowie Server-Stubs per Codegen zu erzeugen, um die Entwicklungszeit drastisch zu verkürzen und die API-Qualität zu sichern.
Details
Inhalt
- Ziele und Erwartungen der Teilnehmenden
- Klärung individueller Lernziele und Erwartungen für ein praxisnahes und relevantes Seminar
- 1. OpenAPI 3.1: Der Standard für moderne APIs
- YAML vs. JSON: Struktur und Syntax der Spezifikation im Überblick.
- Info & Servers: Metadaten und Umgebungs-Definitionen (Dev/Stage/Prod).
- Security Schemes: Definition von OAuth2, API-Keys und Bearer-Tokens.
- 2. Schema-Definition und Datentypen
- Basics: Strings, Numbers, Booleans und Enums präzise definieren.
- Wiederverwendung: Nutzung von $ref zur Vermeidung von Redundanzen.
- Validierung: Constraints wie minimum, maximum, pattern (Regex) und required.
- 3. Fortgeschrittene Schema-Komposition
- Polymorphie: Komposition mit allOf (Vererbung), oneOf und anyOf (Alternative).
- Discriminator: Logik zur Unterscheidung von Datentypen in der Laufzeit.
- JSON Schema 2020-12: Die volle Power der aktuellen Schema-Spezifikation in OAS 3.1.
- 4. Path Items und Operationen
- Endpunkte: Definition von Pfaden und HTTP-Verben (GET, POST, etc.).
- Parameter: In-Path, Query, Header und Cookie Parameter detailliert beschreiben.
- Request & Response: Definition von Request-Bodies und Status-Codes (200, 400, 500).
- 5. Components: Das DRY-Prinzip in der Praxis
- Zentralisierung: Schemas, Parameter und Header in components auslagern.
- Request-Bodies & Responses: Standardisierte Antworten für Fehlermeldungen definieren.
- Modularisierung: Aufteilen großer Spezifikationen in mehrere Dateien.
- 6. Design-First vs. Code-First
- Design-First: Warum der API-Vertrag zuerst stehen sollte (Single Source of Truth).
- Code-First: Wann Annotationen im Code sinnvoll sind und wo die Risiken liegen.
- Entscheidungsmatrix: Welcher Ansatz passt zu Ihrem Team und Projekt?
- 7. API Style Guides und Linting mit Spectral
- API Governance: Definition von Naming-Conventions (CamelCase vs. snake_case).
- Spectral: Erstellung eigener Regelwerke zur automatisierten API-Validierung.
- Automatisierung: Durchsetzung des Style Guides bei jedem Commit.
- 8. Dokumentation und Viewer
- Swagger UI: Interaktive Dokumentation zum Ausprobieren (Try-it-out).
- Redoc & Redocly: Hochwertige, statische Dokumentations-Layouts für Partner.
- Dokumentations-Kultur: Best Practices für Beschreibungen und examples.
- 9. Codegen: SDKs und Server-Stubs generieren
- Openapi-generator: Automatisierte Erstellung von Clients (Java, TS, Swift, etc.).
- Server-Stubs: Generierung von Boilerplate-Code für Spring Boot, Express oder Go.
- Custom Templates: Anpassung des generierten Codes an eigene Standards.
- 10. Mocking und parallele Entwicklung
- Prism: Starten eines lokalen Mock-Servers basierend auf der Spezifikation.
- WireMock + OAS: Simulation komplexer API-Szenarien für automatisierte Tests.
- Vorteil: Frontend-Entwicklung starten, bevor das Backend-Team eine Zeile Code schreibt.
- 11. Praxis-Workshop: "The API Lifecycle"
- Design-Task: Erstellung einer OAS-Definition für eine Ressourcen-Verwaltung.
- Linting-Task: Behebung von Style-Verstößen mittels Spectral-Feedback.
- Codegen-Task: Generierung eines TypeScript-SDKs und Testen gegen einen Prism-Mock.
- Final Roadmap: Integration des Spezifikations-Checks in eine GitHub Action.
- 12. Praxis-Workshop: „The WordPress Security Lab“
- Hardening-Parcours:
- Live-Konfiguration: Umsetzung der .htaccess- und wp-config.php-Härtung an einer aktiven Instanz.
- Database-Surgery: Sicherer Wechsel des Tabellen-Präfix in einer bestehenden Datenbank ohne Datenverlust.
- Endpoint-Defense: Feinjustierung der Firewall-Regeln (Wordfence/Sucuri) zur Blockierung von Brute-Force-Attacken.
- Vulnerability-Audit (Penetration Testing light):
- Scan-Analysis: Durchführung eines vollständigen Scans mit WPScan (CLI oder GUI) und Bewertung der Funde.
- Plugin-Check: Bewertung der „Supply Chain Security“ - Identifikation veralteter oder unsicherer Drittanbieter-Komponenten.
- Disaster Recovery Simulation (Der Ernstfall):
- Malware-Injektion: Analyse einer (kontrolliert) infizierten Website - Wo versteckt sich der Schadcode?
- Cleaning-Session: Manuelle und automatisierte Bereinigung der Datenbank und des Dateisystems.
- Restore-Sprint: Wiederherstellung der sauberen Umgebung aus einem Off-Site-Backup unter Zeitdruck.
- Reporting & Governance:
- Security-Protokoll: Erstellung eines Status-Berichts für die Geschäftsführung (Management Summary).
- Checklisten-Finalisierung: Erarbeitung einer individuellen „Daily Security Routine“ für den eigenen Arbeitsalltag.
- Hardening-Parcours:
Zielgruppe & Vorkenntnisse
- Software-Architekten & Lead Developer: Zur Definition von System-Schnittstellen.
- Backend- & Frontend-Entwickler: Zur Nutzung von Generatoren und Mocks.
- API-Produktmanager: Zur technischen Spezifikation von Anforderungen.
- DevOps-Engineers: Zur Integration von API-Linting in die CI/CD-Pipeline.
Ihre Schulung
In Präsenz | Online |
|---|---|
| Lernmethode | |
Ausgewogene Mischung aus Theorie und Praxis | Wie auch bei unseren Präsenz-Seminaren: Ausgewogene Mischung aus Theorie und praktischen Übungen. Trainer durchgehend präsent. |
| Unterlagen | |
Seminarunterlagen oder Fachbuch inklusive. Das Fachbuch wählt der Trainer passend zum Seminar aus - Ihren individuellen Buch-Wunsch berücksichtigen wir auf Nachfrage gerne. | Seminarunterlagen oder Fachbuch inklusive (via DHL). Das Fachbuch wählt der Trainer passend zum Seminar aus - Ihren individuellen Buch-Wunsch berücksichtigen wir auf Nachfrage gerne. |
| Arbeitsplatz | |
|
|
| Lernumgebung | |
Neu aufgesetzte Remote-Systeme für jeden Kurs in Abstimmung mit dem Seminarleiter, sodass Sie über ein perfektes Setup für die Durchführung aller praktischen Übungen verfügen. | |
| Arbeitsmaterialien | |
Din A4 Block, Notizblock, Kugelschreiber, USB-Stick, Textmarker, Post-its | |
| Teilnahmezertifikat | |
Nach Abschluss des Seminars erhalten Sie das Teilnahmezertifikat inkl. Inhaltsverzeichnis per E-Mail als PDF. | |
Organisation
In Präsenz | Online | |
|---|---|---|
| Teilnehmendenzahl | ||
min. 1, max. 8 Personen | ||
| Garantierte Durchführung * | ||
Ab 1 Teilnehmenden | ||
| Schulungszeiten | ||
| ||
| Ort der Schulung | ||
 GFU SchulungszentrumAm Grauen Stein 27 51105 Köln-Deutz oder online im Virtual Classroom oder europaweit bei Ihnen als Inhouse-Schulung Um ein optimales Raumklima zu gewährleisten, haben wir das Schulungszentrum mit 17 hochmodernen Trotec TAC V+ Luftreinigern ausgestattet. Diese innovative Filtertechnologie (H14 zertifiziert nach DIN EN1822) sorgt dafür, dass die Raumluft mehrfach pro Stunde umgewälzt wird und Schadstoffe zu 99.995% im HEPA-Filter abgeschieden und infektiöse Aerosole abgetötet werden. Zusätzlich sind alle Räume mit CO2-Ampeln ausgestattet, um jederzeit eine hervorragende Luftqualität sicherzustellen. | ||
| Räumlichkeiten | ||
Helle und modern ausgestattete Räume mit perfekter Infrastruktur | Bequem aus dem Homeoffice von überall | |
| All-Inclusive | ||
Frühstück, Snacks und Getränke ganztägig, Mittagessen im eigenen Restaurant, täglich 6 Menüs, auch vegetarisch | Eine Auswahl unserer Frühstücks-Snacks und Nervennahrungs-Highlights senden wir Ihnen mit den Seminarunterlagen via DHL zu. | |
| Barrierefreiheit | ||
Das GFU-Schulungszentrum (Am Grauen Stein 27) ist barrierefrei | - | |
Kostenfreie Services
In Präsenz | Online |
|---|---|
|
|
Buchungsmöglichkeiten
Online oder in Präsenz teilnehmen
Sie können sowohl Online als auch in Präsenz am Seminar teilnehmen. Klicken Sie bei Ihrer Buchung oder Anfrage einfach die entsprechende Option an.
- Lernumgebung in der Cloud
- Inhalte werden auf Wunsch an die Anforderungen Ihres Teams angepasst.
Was bedeutet Offene Schulung und Inhouse Schulung?
Bei einer offenen Schulung stehen Ort und Termin vorab fest. Jeder Interessent kann eine offene Schulung buchen, daher treffen Teilnehmer aus verschiedenen Unternehmen aufeinander.
Inhouse Schulungen können auf Ihren individuellen Schulungsbedarf zugeschnitten werden. Sie bestimmen den Teilnehmerkreis, Termin und Schulungsort.
Ist eine Inhouse Schulung die richtige Wahl?
Bei einer Inhouse Schulung gehen wir auf die individuellen Bedürfnisse Ihres Unternehmens ein und decken den Schulungsbedarf direkt bei Ihnen im Unternehmen ab.
Das spart Zeit und Geld und sorgt für einen schnellen Wissenstransfer Ihrer Mitarbeiter.
Wer kümmert sich um die Technik bei Inhouse Schulungen?
Eine komplette Lernumgebung in der Cloud mit Remote Zugriff ist für uns selbstverständlich. Sie müssen sich um nichts kümmern. Lediglich ein funktionierender PC oder Notebook mit Internetanschluss sollte für jeden Teilnehmer am Schulungstag bereit stehen.
Vorteile einer Inhouse Schulung
- Kompetente Seminarberatung
- Dozenten aus der Praxis
- Auf Ihre Bedürfnisse zugeschnittener individueller Lernstoff
- Sie können den Termin flexibel gestalten, so wie es für Sie am besten passt
- Unsere Inhouse Schulungen können Europaweit durchgeführt werden
- Der Fokus liegt auf Ihrem Schulungsbedarf, somit schonen Sie Ihr Budget
- Wissenslücken Ihrer Mitarbeitet werden schnell geschlossen