Seminar / Training
Inhaltsverzeichnis
- Beschreibung
- Zielgruppe
- Voraussetzungen
- Seminarinhalte
- Praktische Übungen
- Projektbezug
Beschreibung
Ein Developer Portal ist der Zugangspunkt für API-Konsumenten. Es muss Spezifikationen, Einstiegstexte, Authentifizierungshinweise, Testmöglichkeiten, Schlüsselverwaltung und Nutzungsinformationen so verbinden, dass APIs schneller verstanden und sicherer verwendet werden.
Das Seminar behandelt den Aufbau eines wartbaren Portals auf Basis von OpenAPI, Markdown-Inhalten, Custom Pages und Self-Service-Funktionen. Dabei wird besonderer Wert auf Struktur, Konsistenz, Versionierung und Zusammenarbeit zwischen Produkt-, Dokumentations- und Entwicklungsteams gelegt.
Zielgruppe
Geeignet für API-Produktteams, Technical Writers, Developer-Experience-Teams, Backend-Entwickler, Plattformteams und Architekten, die API-Konsumenten mit einer klaren Portalstruktur unterstützen möchten.
Voraussetzungen
Erforderlich sind Grundkenntnisse zu REST, OpenAPI und technischer Dokumentation. Erfahrungen mit Markdown oder API-Spezifikationen sind hilfreich.
Seminarinhalte
Portalstrategie
Definition der Zielgruppen, Portalziele, Inhaltsstruktur und Verantwortlichkeiten. Es wird geklärt, welche Informationen automatisiert aus OpenAPI kommen und welche redaktionell gepflegt werden müssen.
OpenAPI-basierte Dokumentation
Aufbereitung von Pfaden, Operationen, Parametern, Schemas, Beispielen und Fehlerantworten für eine verständliche API-Dokumentation mit testbaren Schnittstellen.
API Explorer und Testbarkeit
Einbindung interaktiver Testmöglichkeiten, Authentifizierungsinformationen, Beispielaufrufe und kontrollierte Testdaten für API-Konsumenten.
Custom Pages und Inhaltsmodell
Erstellung strukturierter Einstiegsseiten, Tutorials, Changelogs, Konzeptseiten und Migrationshinweise. Zusätzlich wird ein Pflegeprozess für Inhalte betrachtet.
Self-Service und API Keys
Abbildung von Registrierung, API-Key-Verwaltung, Nutzungseinsicht und Rollen im Portal-Kontext, sofern entsprechende Gateway-Funktionen eingesetzt werden.
Praktische Übungen
Die Übungen führen von einer vorhandenen API-Spezifikation zu einer nutzbaren Portalstruktur.
- OpenAPI-Spezifikation auf Dokumentationsqualität prüfen und fehlende Beschreibungen identifizieren.
- Portalnavigation mit Einstiegsseite, Konzeptseite und API-Referenz strukturieren.
- Beispielwerte, Fehlerantworten und Authentifizierungshinweise ergänzen.
- API Explorer für einen geschützten Testfall vorbereiten.
- Self-Service-Prozess für API Keys und Nutzungsanzeige fachlich modellieren.
- Redaktionellen Pflegeprozess für Änderungen und Versionen definieren.
Projektbezug
Das Seminar verbessert die Schnittstelle zwischen API-Anbietern und API-Konsumenten. Statt unverbundener Dokumente entsteht eine Portalstruktur, die Spezifikation, Einstieg, Testbarkeit und Self-Service konsistent miteinander verbindet.
Seminar und Anbieter vergleichen
Öffentliche Schulung
Diese Seminarform ist auch als Präsenzseminar bekannt und bedeutet, dass Sie in unseren Räumlichkeiten von einem Trainer vor Ort geschult werden. Jeder Teilnehmer hat einen Arbeitsplatz mit virtueller Schulungsumgebung. Öffentliche Seminare werden in deutscher Sprache durchgeführt, die Unterlagen sind teilweise in Englisch.
Inhausschulung
Diese Seminarform bietet sich für Unternehmen an, welche gleiche mehrere Teilnehmer gleichzeitig schulen möchten. Der Trainer kommt zu Ihnen ins Haus und unterrichtet in Ihren Räumlichkeiten. Diese Seminare können in Deutsch - bei Firmenseminaren ist auch Englisch möglich gebucht werden.
Webinar
Diese Art der Schulung ist geeignet, wenn Sie die Präsenz eines Trainers nicht benötigen, nicht Reisen können und über das Internet an einer Schulung teilnehmen möchten.
Fachbereichsleiter / Leiter der Trainer / Ihre Ansprechpartner
-
Michael Adler
Telefon: + 41 (800) 225127
E-Mail: michael.adler@seminar-experts.ch -
Stefano Conti
Telefon: + 41 (800) 225127
E-Mail: stefano.conti@seminar-experts.ch
Seminardetails
| Dauer: | 2 Tage ca. 6 h/Tag, Beginn 1. Tag: 10:00 Uhr, weitere Tage 09:00 Uhr |
| Preis: |
Öffentlich und Webinar: CHF 1.198 zzgl. MwSt. Inhaus: CHF 3.400 zzgl. MwSt. |
| Teilnehmeranzahl: | min. 2 - max. 8 |
| Teilnehmer: | API-Produktteams, Technical Writers, Developer-Experience-Teams, Backend-Entwickler, Plattformteams |
| Voraussetzungen: | Grundkenntnisse in REST, OpenAPI und technischer Dokumentation |
| Standorte: | Basel, Bern, Luzern, Sankt Gallen, Winterthur, Zürich |
| Methoden: | Vortrag, Demonstrationen, praktische Übungen am System |
| Seminararten: | Öffentlich, Webinar, Inhaus, Workshop - Alle Seminare mit Trainer vor Ort, Webinar nur wenn ausdrücklich gewünscht |
| Durchführungsgarantie: | ja, ab 2 Teilnehmern |
| Sprache: | Deutsch - bei Firmenseminaren ist auch Englisch möglich |
| Seminarunterlage: | Dokumentation auf Datenträger oder als Download |
| Teilnahmezertifikat: | ja, selbstverständlich |
| Verpflegung: | Kalt- / Warmgetränke, Mittagessen (wahlweise vegetarisch) |
| Support: | 3 Anrufe im Seminarpreis enthalten |
| Barrierefreier Zugang: | an den meisten Standorten verfügbar |
| Weitere Informationen unter +41 (800) 225127 |
Seminartermine
Die Ergebnissliste kann durch Anklicken der Überschrift neu sortiert werden.
