Skip to content

Commit

Permalink
#6 initial version of chapter 3
Browse files Browse the repository at this point in the history
  • Loading branch information
sippsack committed Nov 19, 2024
1 parent 32c0499 commit 82a854a
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 18 deletions.
4 changes: 2 additions & 2 deletions docs/03-api-styles/00-structure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
// ====================================================

// tag::DE[]
== Der Titel des dritten Moduls
== API Stile und Technologien
// end::DE[]

// tag::EN[]
== The Third Module's Title
== API Styles and Technologies
// end::EN[]

include::01-duration-terms.adoc[{include_configuration}]
Expand Down
4 changes: 2 additions & 2 deletions docs/03-api-styles/01-duration-terms.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
// tag::DE[]
|===
| Dauer: XXX Min. | Übungszeit: XXX Min.
| Dauer: 60 Min. | Übungszeit: 30 Min.
|===

=== Begriffe und Konzepte
Begriff 1, Begriff 2, Begriff 3

RPC, Ressource, Hypermedia, Query, Events, asynchrone Kommunikation, gRPC, HTTP APIs, REST, GraphQL

// end::DE[]

Expand Down
34 changes: 20 additions & 14 deletions docs/03-api-styles/02-learning-goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,30 @@

// tag::DE[]
[[LZ-3-1]]
==== LZ 3-1: Dies ist das erste Lernziel in Kapitel 3, das mit xyz
==== LZ 3-1: Grundlegende API-Stile 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.
Die folgenden API-Stile werden erläutert und ihre Vor- sowie Nachteile gegeneinander abgewogen:

* Erstes Teilziel
* Zweites Unterthema
* Dritter Aspekt
* RPC (Remote Procedure Call)
* Resourcen-basiert
* Hypermedia
* Query
* Events & asynchrone Kommunikation

[[LZ-3-2]]
==== LZ 3-2: Hier ist ein zweites Lernziel in diesem Kapitel
tbd.
==== LZ 3-2: Populäre API-Technologien ein- und den jeweiligen API-Stilen zuordnen

Teilnehmer:innen können die wichtigsten populären API-Technologien einordnen und kennen den von ihnen implementierten API-Stil, z. B.:

* gRPC
* HTTP APIs
* REST
* GraphQL

[[LZ-3-3]]
==== LZ 3-3: Auswahlkriterien und Konsequenzen von API-Stilen & Technologien kennen

Teilnehmer:innen erwerben ein Verständnis für Kriterien, wann welche Stile/Technologien besser oder weniger gut passen und welche Konsequenzen die jeweilige Auswahl mit sich bringt.

// end::DE[]

Expand All @@ -27,8 +38,3 @@ tbd.
==== LG 3-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.
====

0 comments on commit 82a854a

Please sign in to comment.