Schulung · Workshop · Coaching · Beratung

TypeSpec Schulung: APIs design-first, OpenAPI daraus erzeugen

TypeSpec: APIs design-first beschreiben und OpenAPI daraus erzeugen

Dauer: ab 1 Tag (8 UE) | Preis: ab 900 EUR (netto) | Live online oder vor Ort | Termin nach Vereinbarung

Sie beschreiben APIs kompakt in TypeSpec, erzeugen daraus OpenAPI 3, JSON Schema und Protobuf und setzen einheitliche API-Richtlinien über wiederverwendbare Bibliotheken und Linter durch.

Gesamtpreis für bis zu 3 Teilnehmende · Unverbindliche Anfrage · Keine Vorkasse

Dutzende APIs einheitlich beschreiben – ohne Tausende Zeilen YAML

TypeSpec ist eine von Microsoft entwickelte Open-Source-Sprache, mit der Sie APIs design-first beschreiben: Modelle, Operationen und Routen in einer knappen, typisierten Syntax, aus der der Compiler OpenAPI 3, JSON Schema oder Protocol Buffers erzeugt. Was in OpenAPI als Hunderte Zeilen wiederholter Schemas und Antworten auftaucht, steht in TypeSpec einmal als Vorlage und wird überall wiederverwendet. Seit Version 1.0 im Jahr 2025 gelten Compiler, HTTP-Bibliothek und OpenAPI-Emitter als stabil; Microsoft beschreibt damit unter anderem die Azure-APIs.

Die Schulung beginnt mit der Frage, wann sich eine eigene API-Definitionssprache lohnt, und richtet dann Compiler, Projektvorlage und die TypeSpec-Erweiterung für VS Code ein. Sie arbeiten mit Namespaces, Modellen, Skalaren, Enums und Unions, nutzen Vorlagen, Spread und Dekoratoren und bauen daraus HTTP-Services mit Routen, Parametern und Antworttypen. Validierungsregeln wie Längen, Wertebereiche und Muster sowie einheitliche Fehlerantworten definieren Sie zentral. Danach kompilieren Sie nach OpenAPI 3.0, 3.1 oder 3.2, erzeugen JSON Schema und Protobuf aus demselben Modell und sehen, wie sich Versionen mit der Versioning-Bibliothek abbilden lassen. Grundsatzfragen des Ressourcen- und URI-Entwurfs gehören ins Seminar „REST und RESTful API“; TypeSpec ist das Werkzeug, mit dem Sie die dort getroffenen Entscheidungen festhalten und teamübergreifend durchsetzen.

Für Coding-Agenten ist TypeSpec eine ergiebige Quelle, weil die .tsp-Dateien klein genug sind, um sie vollständig im Kontext zu halten, und der Compiler jede Unstimmigkeit mit Position meldet. In unseren Übungen arbeitet Copilot als Agent im Editor ausschließlich an den TypeSpec-Quellen, tsp compile mit Warnungen als Fehler bildet die Rückmeldung, und die erzeugte OpenAPI-Datei wird ausschließlich im Diff gelesen, nie von Hand korrigiert. Bestehende OpenAPI-Dokumente überführen Sie mit dem Konvertierungswerkzeug nach TypeSpec und lassen den Agenten anschließend Wiederholungen in Vorlagen zusammenziehen.

Zum Schluss setzen Sie API-Richtlinien mit Linter-Regeln in tspconfig.yaml um, gehen typische Fehlerquellen bei Dekoratoren, Sichtbarkeit und Emitter-Optionen durch und entwickeln am Praxisbeispiel eine produktionsnahe API. Kenntnisse in OpenAPI oder einer typisierten Sprache wie TypeScript oder C# erleichtern den Einstieg; vorhandene Spezifikationen Ihres Teams eignen sich gut als Material für die Konvertierungsübung.

Die meisten Organisationen haben kein Problem, APIs zu beschreiben – sie haben ein Problem, sie gleich zu beschreiben. Jedes Team erfindet eigene Fehlerobjekte, eigene Paginierung, eigene Namenskonventionen, und OpenAPI-Dateien mit vierstelliger Zeilenzahl liest niemand mehr vollständig. TypeSpec dreht das um: Konventionen werden zu Vorlagen und Bibliotheken, die alle Teams importieren, und der Compiler sagt, wer davon abweicht. Die OpenAPI-Datei wird zum Build-Ergebnis, nicht mehr zum Dokument, an dem man arbeitet.

Was Sie danach können

  • Sie beschreiben HTTP-APIs mit Modellen, Operationen, Routen und Dekoratoren in TypeSpec
  • Sie definieren Validierungsregeln und einheitliche Fehlerantworten zentral und wiederverwendbar
  • Sie erzeugen aus einem Modell OpenAPI 3, JSON Schema und Protocol Buffers und prüfen die Ausgabe
  • Sie setzen TypeSpec in VS Code und Visual Studio ein und binden die Kompilierung in CI ein
  • Sie setzen API-Richtlinien mit Linter-Regeln und einer gemeinsamen Bibliothek durch
  • Sie kennen die Code-Generierung für TypeScript und C# aus TypeSpec im Überblick

Zielgruppe und Voraussetzungen

  • API-Architekt:innen, die viele APIs einheitlich beschreiben wollen
  • Entwickler:innen, die OpenAPI-Dokumente pflegen und Wiederholung reduzieren möchten
  • Plattform- und Governance-Teams, die API-Richtlinien automatisiert prüfen
Themen und Inhalte für Ihre Beratung, Coaching, Workshop, Training, Schulung und Weiterbildung:

TypeSpec: APIs design-first beschreiben und OpenAPI daraus erzeugen

Warum TypeSpec?
  • Einführung in TypeSpec: warum eine eigene Sprache für API-Definitionen statt YAML von Hand
  • Design-first vs. code-first: wo TypeSpec im API-Lebenszyklus steht
  • TypeSpec und OpenAPI: Quellsprache und Ausgabeformat, nicht Konkurrenz
  • Herkunft und Stand: Open Source von Microsoft, stabile Version 1.x seit 2025
Installation und Einrichtung
  • Installation der TypeSpec-Umgebung: Node.js, Compiler @typespec/compiler und CLI tsp
  • Projekt anlegen mit tsp init, Abhängigkeiten mit tsp install
  • Konfiguration in tspconfig.yaml: Emitter, Ausgabeverzeichnis und Optionen
  • TypeSpec-Erweiterungen für VS Code und Visual Studio: Diagnosen, Vervollständigung, Vorschau
  • TypeSpec Playground im Browser zum schnellen Ausprobieren
Die wichtigsten Sprachkonzepte
  • Namespaces, import und using: Definitionen über Dateien und Bibliotheken ordnen
  • Modelle, Eigenschaften, optionale Felder und Standardwerte
  • Skalare, Enums und Unions für fachliche Datentypen
  • Vorlagen, Spread ..., extends und model is gegen Wiederholung
  • Operationen und Interfaces als Bausteine von Schnittstellen
  • Dekoratoren und Dokumentationskommentare als Metadaten im Modell
HTTP-APIs mit TypeSpec definieren
  • Aufbau einer API-Struktur mit @service und Namespaces für Bereiche
  • Endpunkte und Operationen anlegen: @route, @get, @post, @put, @patch, @delete
  • Parameter mit @path, @query, @header und Inhalte mit @body
  • Antworten mit @statusCode und mehreren Antworttypen als Union
  • Authentifizierung beschreiben mit @useAuth: API-Schlüssel, Bearer, OAuth 2
Datenmodelle, Validierung und Fehlerantworten
  • Datenmodelle definieren und validieren: @minLength, @maxLength, @pattern
  • Wertebereiche mit @minValue, @maxValue und Formate für Datum, Zeit und UUID
  • Sichtbarkeit: ein Modell für Lesen, Anlegen und Ändern mit @visibility und Lifecycle
  • Fehlerbehandlung integrieren: Fehlermodelle mit @error, einheitlich etwa als Problem Details
  • Gemeinsame Fehler- und Paginierungsvorlagen als Bibliothek für alle Services
Kompilieren nach OpenAPI, JSON Schema und Protobuf
  • API-Spezifikationen in OpenAPI kompilieren: Emitter @typespec/openapi3, Version 3.0, 3.1 oder 3.2
  • Erzeugte OpenAPI-Datei prüfen: Referenzen, Operations-IDs, Beschreibungen
  • API-Definitionen in JSON Schema umwandeln mit @typespec/json-schema
  • Protocol Buffers erzeugen mit @typespec/protobuf (Vorschau): Pakete, Feldnummern, Dienste
  • Bestehende OpenAPI-Dokumente nach TypeSpec konvertieren mit tsp-openapi3
  • Client-Code per Vorschau-Emitter für C#, TypeScript, Python, Java; Server-Code nur für JavaScript und C# (Alpha)
API-Richtlinien durchsetzen
  • Einhaltung von API-Richtlinien sicherstellen: Linter in tspconfig.yaml aktivieren
  • Eigene Linter-Regeln in einer TypeSpec-Bibliothek schreiben, z. B. für Namenskonventionen
  • Hausbibliothek mit Vorlagen, Dekoratoren und Regeln als npm-Paket verteilen
  • TypeSpec in CI: kompilieren, Warnungen als Fehler, erzeugte Artefakte vergleichen
Fortgeschrittene Features
  • Fortgeschrittene Features von TypeSpec: Versionierung (Vorschau) mit @versioned, @added, @removed
  • Eigene Dekoratoren in TypeScript oder ab 1.14 als auto dec ohne JavaScript (experimentell)
  • Mehrere Ausgabeformate aus einem Modell: Optionen je Emitter sauber trennen
Fehlerquellen und Best Practices
  • Typische Fehlerquellen analysieren: fehlende using-Anweisungen, Namenskonflikte, Versionsmix
  • Compiler-Diagnosen lesen und beheben, #suppress nur mit Begründung
  • Unerwartete Ausgaben: Sichtbarkeit, anonyme Modelle und Benennung im erzeugten Schema
  • Best Practices für eine zukunftssichere API-Architektur: kleine Dateien, gemeinsame Bibliothek, Changelog
  • TypeSpec-Pakete pinnen und Updates der 1.x-Reihe mit Diff der Ausgabe einspielen
TypeSpec mit Coding-Agenten pflegen
  • Agent ändert nur .tsp-Quellen; tsp-output/ ist Build-Ergebnis und für ihn tabu
  • tsp compile . --warn-as-error als Rückmeldung nach jeder Änderung, Diagnosen mit Datei und Zeile
  • Diff der erzeugten OpenAPI-Datei im Pull Request als eigentliches Review-Objekt
  • Nach tsp-openapi3 zieht der Agent Wiederholungen in Vorlagen zusammen, die Ausgabe muss gleich bleiben
  • Neue Linter-Regel vom Agenten schreiben lassen, mit Positiv- und Negativbeispiel als Test
Praxisprojekt: Terminbuchungs-API für Arztpraxen in TypeSpec
  • Praxisbeispiel einer produktionsreifen API: Praxen, Termine und Buchungen in TypeSpec modellieren
  • Gemeinsame Bibliothek mit Fehlermodell, Paginierung und Linter-Regel einbinden
  • OpenAPI 3.1 und JSON Schema erzeugen und gegen einen Mock-Server testen
  • Version 2 mit neuem Feld und entferntem Endpunkt per Versioning-Bibliothek abbilden

*) Die Inhalte werden individuell abgestimmt und mit Praxisbeispielen abgerundet.

Ein Symbol für einen Kalender.

Offene Termine

Kostenlose Reservierung
Ein Symbol für Angebot erhalten.

Unser Angebot

Individuelle Schulung für Einzelpersonen und Teams – live online oder vor Ort.

Dauer

Ein Symbol für Dauer.
ab 1 Tag (8 UE)

Die Dauer richtet sich nach Ihren Inhalten.

Preis

Ein Symbol für Preis.
ab 900 EUR (Nettopreis)
ab 1.071 EUR (Bruttopreis)

Die Preise verstehen sich bei Unternehmern gemäß § 14 BGB zzgl. MwSt. Der dargestellte Ab-Preis gilt für firmeninterne Veranstaltungen und entspricht dem niedrigsten Gesamtpreis für Veranstaltungen mit bis zu drei (3) Teilnehmenden.

Termin

Ein Symbol für einen Kalender.
Ganztägig + halbtägig
nach Vereinbarung

Ganztägig oder halbtägig nach Vereinbarung, live online oder vor Ort.

Ihre Vorteile

Ein Symbol für ein Vorgespräch durchführen.
Persönliches Vorgespräch
Ein Symbol für die individuelle Vorbereitung.
Individuelle Vorbereitung
Ein Symbol für Experten aus der Praxis.
Experten aus der Praxis
Ein Symbol für ein Zertifikat.
Inklusive Zertifikat

Unsere Garantien

1. Relevanz-Garantie

Wir passen den Inhalt spezifisch an die Bedürfnisse jedes Teilnehmers an. Irrelevante Themen werden ausgespart, um den größtmöglichen Nutzen zu garantieren.

2. Qualitäts-Garantie

Durch regelmäßiges Feedback optimieren wir unsere Schulungen kontinuierlich und garantieren Ihnen ein Lernerlebnis der Extraklasse.

3. Zufriedenheits-Garantie

Unsere Zufriedenheitsgarantie spricht für sich – bei Unzufriedenheit entstehen Ihnen keine Kosten.

Wir helfen gerne weiter!

Rufen Sie uns an, schreiben eine E-Mail oder nutzen das Kontaktformular.

Schulung anfragen

Unverbindlich · Keine Vorkasse

Einige Unternehmen, für die wir tätig waren

Nexum AG

ITZ Bund Ilmenau

ITSD Consulting GmbH

Teilnehmer

Feedback

Herr Hecker ist sehr gut auf individuelle Wünsche, Fragen und Anregungen eingegangen. Eine sehr informative, interessante und gelungene Veranstaltung.
Teilnehmer

Feedback

Herr Hecker hat das Thema sehr anschaulich dargestellt und ist auf alle Fragen eingegangen. Ich fühle mich jetzt gut vorbereitet, um durchzustarten.
Teilnehmer

Feedback

Die gelassene, professionelle Art hat mir gut gefallen. Kompetent, engagiert, professionell. Gute Beispiele, sympathisches Auftreten. Eigene Themenideen wurden aufgegriffen.
Unser Angebot für Ihre firmeninterne Beratung, Coaching, Workshop, Training und Weiterbildung

Lösungen für Ihren Bedarf an Coaching, Workshop, Training, Schulung und Weiterbildung

Profitieren Sie von unserer langjährigen Expertise in der beruflichen Weiterbildung, modernen Lernmethoden und einem Portfolio von über 600 IT-, Online- und Digital-Beratungsleistungen.
Selbstverständlich lassen sich die einzelnen Themen kombinieren. So erhalten Sie genau die Weiterbildung, die Sie wünschen und brauchen - als Coaching, Workshop, Training, Schulung und Weiterbildung!

✓
Ein Symbol für eine einzelne Person.

Für eine Person

Training & Coaching für Einzelpersonen

  • Passgenaue Inhalte auf den einzelnen Teilnehmer zugeschnitten
  • Ein sehr effektives Format, das schnell Ergebnisse bringt
  • Individuelles Training und Coaching motivieren und wirken
Jetzt anfragen
✓
Ein Symbol für eine Gruppe von Personen.

Für eine Gruppe

Training & Workshops für Teams und Abteilungen

  • Bedarfsgerechte Inhalte auf die Herausforderung der Praxis zugeschnitten
  • Konsequente Praxisorientierung, modernste Techniken und Tools
  • Neue Fähigkeiten und Kenntnisse nachhaltig in den Arbeitsalltag integrieren
Jetzt anfragen
✓
Ein Symbol für ein Unternehmen.

Für eine Firma

Training-Komplett-Lösungen für Ihr Unternehmen‍

  • Ganzheitliche Konzepte für Ihre Mitarbeiterentwicklung
  • Individueller Skill-Katalog zur Erweiterung Ihres internen Weiterbildungsangebots
  • Nachhaltige Personalentwicklung realisieren
Jetzt anfragen

Intern vorschlagen

Sie entscheiden nicht allein über die Schulung? Hier finden Sie die Agenda zum Weiterleiten und einen fertigen Vorschlag für die Person, die entscheidet.

Ohne Formular und ohne Anmeldung – Sie schicken den Vorschlag selbst.

So wird daraus Ihre Firmenschulung

1. Bedarf klären: Im kostenlosen Vorgespräch besprechen wir Ziele, Vorkenntnisse und Praxisaufgaben.

2. Angebot abstimmen: Inhalte, Format (live online oder vor Ort), Dauer und Preis legen wir gemeinsam fest.

3. Schulung durchführen: Sie arbeiten an Übungen aus Ihrem Alltag oder an einem neutralen Beispiel und nehmen konkrete nächste Schritte mit.

Häufige Fragen zur Schulung

Gilt der Ab-Preis pro Person oder für die Veranstaltung?

Die 900 EUR netto sind der niedrigste Gesamtpreis für eine firmeninterne Veranstaltung mit bis zu drei Teilnehmenden. Größere Gruppen und einen anderen Umfang bieten wir individuell an. Der verbindliche Preis steht in Ihrem Angebot.

Können wir eigene Aufgaben einbringen?

Ja. Welche Aufgaben sich eignen, welche Zugänge nötig sind und wie wir die Vertraulichkeit sichern, klären wir im Vorgespräch. Alternativ arbeiten wir an einem neutralen Beispiel.

Ist die Anfrage schon eine Buchung?

Nein. Sie erhalten zuerst ein abgestimmtes Angebot und entscheiden dann über die Beauftragung. Eine Vorkasse gibt es nicht.

Ihre unverbindliche und kostenlose Schulungsanfrage zum Thema

TypeSpec - Beratung, Coaching, Workshop, Training, Schulung und Weiterbildung

Schildern Sie uns kurz Ihren Bedarf. Ziele, Inhalte und Termin stimmen wir persönlich mit Ihnen ab.

*) Die Angabe erfolgt freiwillig. Wir nutzen Ihre Telefonnummer ausschließlich, um Ihre Anfrage effizienter zu bearbeiten oder Rückfragen zu klären.

Ich interessiere mich für den Termin:

Termin anfragen

Das Angebot von "HECKER CONSULTING" richtet sich ausschließlich an Unternehmen und Behörden (iSv § 14 BGB). Verbraucher (§ 13 BGB) sind vom Vertragsschluss ausgeschlossen. Mit Absendung der Anfrage bestätigt der Anfragende, dass er nicht als Verbraucher, sondern in gewerblicher Tätigkeit handelt. § 312i Abs. 1 S. 1 Nr. 1-3 und S. 2 BGB (Pflichten im elektronischen Geschäftsverkehr) finden keine Anwendung.

Vielen Dank, Ihre Nachricht wurde empfangen!
Beim Absenden des Formulars ist etwas schiefgelaufen.
Beratung, Coaching, Workshop, Training, Schulung

Ähnliche Leistungen, die Sie interessieren könnten.

Wir erweitern ständig unser Beratungsportfolio. Über 600 IT-, Online-, Digital-Beratungsleistungen haben wir für Sie im Programm. Selbstverständlich lassen sich die einzelnen Themen kombinieren. So erhalten Sie genau die Beratung, die Sie wünschen und brauchen - als Coaching, Workshop, Training, Schulung und Weiterbildung!

Mehr IT-, Online-, Digital-Beratungsleistungen anzeigen >>
Nach oben