Skip to content

Commit

Permalink
#11 initial version of chapter 6
Browse files Browse the repository at this point in the history
  • Loading branch information
sippsack committed Nov 20, 2024
1 parent 0d59d72 commit b8b95b7
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 47 deletions.
4 changes: 2 additions & 2 deletions docs/06-api-lifecycle/00-structure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}]
Expand Down
17 changes: 4 additions & 13 deletions docs/06-api-lifecycle/01-duration-terms.adoc
Original file line number Diff line number Diff line change
@@ -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.
====
42 changes: 21 additions & 21 deletions docs/06-api-lifecycle/02-learning-goals.adoc
Original file line number Diff line number Diff line change
@@ -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.
====
11 changes: 0 additions & 11 deletions docs/06-api-lifecycle/references.adoc
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@
=== {references}

<<starke>>

[NOTE]
====
Eine Quelle wird über `\<<label>>` referenziert. Dieses muss in `99-references/00-references.adoc` definiert sein.
= = =
A reference source is referenced via `\<<label>>`. The label has to be defined in `99-references/00-references.adoc`.
====

// tag::DE[]
// silence asciidoctor warnings
// end::DE[]
Expand Down

0 comments on commit b8b95b7

Please sign in to comment.