From b8b95b79b40897c008644e21e060caff23f5c79b Mon Sep 17 00:00:00 2001 From: Falk Sippach Date: Thu, 21 Nov 2024 00:25:32 +0100 Subject: [PATCH] #11 initial version of chapter 6 --- docs/06-api-lifecycle/00-structure.adoc | 4 +- docs/06-api-lifecycle/01-duration-terms.adoc | 17 ++------ docs/06-api-lifecycle/02-learning-goals.adoc | 42 ++++++++++---------- docs/06-api-lifecycle/references.adoc | 11 ----- 4 files changed, 27 insertions(+), 47 deletions(-) diff --git a/docs/06-api-lifecycle/00-structure.adoc b/docs/06-api-lifecycle/00-structure.adoc index 9a32fdf..bcf851e 100644 --- a/docs/06-api-lifecycle/00-structure.adoc +++ b/docs/06-api-lifecycle/00-structure.adoc @@ -3,11 +3,11 @@ // ==================================================== // tag::DE[] -== Und so heißt Modul 5 +== API Lifecycle und API Tooling // end::DE[] // tag::EN[] -== And This is Module no 5 +== API Lifecycle and API Tooling // end::EN[] include::01-duration-terms.adoc[{include_configuration}] diff --git a/docs/06-api-lifecycle/01-duration-terms.adoc b/docs/06-api-lifecycle/01-duration-terms.adoc index d1bb5f8..fb14e00 100644 --- a/docs/06-api-lifecycle/01-duration-terms.adoc +++ b/docs/06-api-lifecycle/01-duration-terms.adoc @@ -1,29 +1,20 @@ // tag::DE[] |=== -| Dauer: XXX Min. | Übungszeit: XXX Min. +| Dauer: 90 Min. | Übungszeit: 60 Min. |=== === Begriffe und Konzepte -Begriff 1, Begriff 2, Begriff 3 + +API Lifecycle, API Produkt, Linting, Consumer-driven Contract Testing, API Gateway // end::DE[] // tag::EN[] |=== -| Duration: XXX min | Practice time: XXX min +| Duration: 90 min | Practice time: 60 min |=== === Terms and Principles Term 1, Term 2, Term 3 // end::EN[] - -[NOTE] -==== -Überschrift in 00-structure.adoc ersetzen -==== - -[NOTE] -==== -Sinnvolle Zeiten für Dauer und Übungszeit eintragen, vernünftige Begriffe aufzählen. -==== diff --git a/docs/06-api-lifecycle/02-learning-goals.adoc b/docs/06-api-lifecycle/02-learning-goals.adoc index 026e525..0bc29c1 100644 --- a/docs/06-api-lifecycle/02-learning-goals.adoc +++ b/docs/06-api-lifecycle/02-learning-goals.adoc @@ -1,34 +1,34 @@ === {learning-goals} - // tag::DE[] -[[LZ-5-1]] -==== LZ 5-1: Dies ist das erste Lernziel in Kapitel 5, lorem ipsum sit dolor +[[LZ-6-1]] +==== LZ 6-1: API Lifecycle verstehen -Hier wird beschrieben, was Teilnehmer:innen in diesem Lernziel lernen sollen. Das kann in Prosa-Text -in ganzen Sätzen oder in Aufzählungen mit Unterpunkten erfolgen. Dabei kann auch unterschieden werden, -wie wichtig einzelne Aspekte des Lernziels sind. Es kann hier bereits auf Literatur verwiesen werden. +Teilnehmer:innen kennen verschiedene Schritte des Entwicklungszyklus eines API Produkts und die typischen Aufgaben, die bei diesen Schritten anfallen. +Die Aufteilung in Planung und Anforderungsanalyse, Design und Prototyping, Entwicklung, Testing und Qualitätsprüfung, Deployment und Veröffentlichung, Betrieb und Wartung sowie Verbesserung und Iteration sind bekannt. +Ebenfalls bekannt sind die verschiedenen Lebensphasen eines APIs wie Prototyp, produktiver Betrieb, Deprecation und das Abschalten. -* Erstes Teilziel -* Zweites Unterthema -* Dritter Aspekt +[[LZ-6-2]] +==== LZ 6-2: APIs als Produkte verwalten + +APIs kommen oft in lose gekoppelten Szenarien zum Einsatz und aus diesem Grund ist es sinnvoll, sie als Produkte zu managen. +Teilnehmer:innen verstehen, was es bedeutet, eine API als Produkt zu verwalten. +Dies beginnt beim Zielgruppenfokus, berücksichtigt Fragen der Nutzbarkeit, von Feedback sowie Verbesserung und behandelt auch Fragen von Deprecation und der Bereitstellung von Alternativen. + +[[LZ-6-3]] +==== LZ 6-3: API Lifecycle Tooling kennen + +Teilnehmer:innen kennen typische Tools für den Einsatz im API Lifecycle zur Unterstützung von Produzenten und Konsumenten wie Linting, Testing (z. B. Consumer-driven Contract Testing), Mocking sowie Betrieb (API Gateways). +Teilnehmer:innen können mit einigen dieser Tools praktisch arbeiten und verstehen sie in das Gesamtbild des API Lifecycle Tooling einzuordnen. -[[LZ-5-2]] -==== LZ 5-2: Hier ist ein zweites Lernziel in diesem Kapitel -tbd. // end::DE[] // tag::EN[] -[[LG-5-1]] -==== LG 5-1: TBD +[[LG-6-1]] +==== LG 6-1: TBD tbd. -[[LG-5-2]] -==== LG 5-2: TBD +[[LG-6-2]] +==== LG 6-2: TBD tbd. // end::EN[] - -[NOTE] -==== -Die einzelnen Lernziele müssen nicht als einfache Aufzählungen mit Unterpunkten aufgeführt werden, sondern können auch gerne in ganzen Sätzen formuliert werden, welche die einzelnen Punkte (sofern möglich) integrieren. -==== diff --git a/docs/06-api-lifecycle/references.adoc b/docs/06-api-lifecycle/references.adoc index 459da49..6c93627 100644 --- a/docs/06-api-lifecycle/references.adoc +++ b/docs/06-api-lifecycle/references.adoc @@ -1,16 +1,5 @@ === {references} -<> - -[NOTE] -==== -Eine Quelle wird über `\<