Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

initial version of chapter 6 #15

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sollen wir "Consumer-driven" rausschmeissen und einfach nur "Contract Testing"?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oder vielleicht "Consumer-driven" in Klammern?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, wenn das hilft auch gut. Je weniger wir uns festlegen auf spezielle Nischen desto besser.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ja, finde ich gut. Passe ich noch an.


// 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

eine -> ein

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kann ich ändern. Gibt es bei API eine offizielle Meinung zu ein/eine? Ich nehme ich "eine" als eine Schnittstelle. Aber ein Interface ist vermutlich passender.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gibt es da Kulturkampfdiskussionen? Das sollten wir vermeiden, da werde ich dann sehr schnell sehr flexibel.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ich würde auch "ein" sagen, denn es ist das Interface, das API. Es gibt aber keine Vorgabe oder ähnliches.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Und tatsächlich verwenden alle Quellen, die ich auf die Schnelle finde, "API-Design" als Schreibweise. Also mit Bindestrich.

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wie oben vorgeschlagen "Consumer-driven" loeschen?

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