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 5 #14

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/05-openapi/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
== Beschreibung von APIs am Beispiel OpenAPI
// end::DE[]

// tag::EN[]
== And This is Module no 5
== Description of APIs using the example of OpenAPI
// end::EN[]

include::01-duration-terms.adoc[{include_configuration}]
Expand Down
14 changes: 2 additions & 12 deletions docs/05-openapi/01-duration-terms.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// tag::DE[]
|===
| Dauer: XXX Min. | Übungszeit: XXX Min.
| Dauer: 90 Min. | Übungszeit: 30 Min.
|===

=== Begriffe und Konzepte
Expand All @@ -10,20 +10,10 @@ Begriff 1, Begriff 2, Begriff 3

// tag::EN[]
|===
| Duration: XXX min | Practice time: XXX min
| Duration: 90 min | Practice time: 30 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.
====
40 changes: 24 additions & 16 deletions docs/05-openapi/02-learning-goals.adoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,34 @@
=== {learning-goals}


// tag::DE[]
[[LZ-5-1]]
==== LZ 5-1: Dies ist das erste Lernziel in Kapitel 5, lorem ipsum sit dolor

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.
==== LZ 5-1: Wichtigkeit von API Beschreibungen kennen

* Erstes Teilziel
* Zweites Unterthema
* Dritter Aspekt
Teilnehmer:innen verstehen den Nutzen von API-Beschreibungen und kennen die Zielgruppen. Das Problem des "API Drift" ist bekannt. Sie können das Zusammenspiel von Design, Implementierung, Versionierung, Beschreibung, Versionierung der Beschreibung einordnen und wie diese Dinge im Idealfall sowie in der Realität praktiziert werden.
Copy link
Contributor

Choose a reason for hiding this comment

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

API-Beschreibung besser ohne Bindestrich?

Copy link

@thfro thfro Nov 22, 2024

Choose a reason for hiding this comment

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

Gleiches Thema wie bei "API Design" vs "API-Design". Ich glaube, in "API-Beschreibung" muss ein Bindestrich hin, weil "Beschreibung" ein deutsches Wort ist. Und bei "API Drift" muss keiner hin, weil "Drift" ein englisches Wort ist. Aber 100% sicher bin ich mir nicht.
In jedem Fall sollte die Schreibweise aber in Überschrift und Textblock einheitlich sein.

Copy link
Contributor

Choose a reason for hiding this comment

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

Mein Gefühl für Deutsch ist etwas angeschlagen, wahrscheinlich von englischer Grammatik. Ich finde die deutschen Bindestrich-Exzesse wenig hilfreich, aber der Duden mag da anderes denken.


[[LZ-5-2]]
==== LZ 5-2: Hier ist ein zweites Lernziel in diesem Kapitel
tbd.
==== LZ 5-2: OpenAPI als Beschreibungssprache für HTTP APIs einordnen

Teilnehmer:innen verstehen OpenAPI als eine auf HTTP APIs spezialisierte Beschreibungssprache.
Sie kennen die Geschichte von OpenAPI und wie sich die verschiedenen Versionen entwickelt haben.
Teilnehmer:innen wissen, wie sich OpenAPI zur Codegenerierung auf der Anbieter- oder Konsumentenseite verwenden lässt.
Copy link

Choose a reason for hiding this comment

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

Codegenerierung oder Code-Generierung?

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äre für ohne Bindestrich.

Die generellen Strukturen von JSON und YAML sind bekannt.

[[LZ-5-3]]
==== LZ 5-3: Der Aufbau von OpenAPI verstehen

Teilnehmer:innen verstehen die Hauptelemente einer OpenAPI Beschreibung und wie diese für konkrete APIs verwendet werden.

* Resourcen (Paths)
* Interaktionen
* Repräsentationen
* Mechanismen wie Tags, Security, Components und Webhooks

[[LZ-5-4]]
==== LZ 5-4: Alternative Beschreibungssprachen kennen

OpenAPI ist spezialisiert auf HTTP APIs. Für andere API-Stile können alternative Beschreibungssprachen mit ähnlichen generellen Zielen verwendet werden. Teilnehmer:innen kennen diese alternativen Beschreibungssprachen und können sie API-Stilen zuordnen.

// end::DE[]

// tag::EN[]
Expand All @@ -27,8 +40,3 @@ tbd.
==== LG 5-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/05-openapi/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