initial version of chapter 4 #9
Conversation
|
Build Successful! You can find a link to the downloadable artifacts below.
|
sippsack
changed the title
| // end::DE[] | ||
|
|
||
| // tag::EN[] | ||
| == Fourth Module, This is its Title | ||
| == API Design |
|
|
||
| Design von API-Schnittstellen, API First, konsumentengetriebenes API-Design, Postel's Law, Forward und Backward Compatibility, Versionierung und Lebenszyklus von API Produkten, JSON:API, API Design Style Guides |
There was a problem hiding this comment.
API-Design eher ohne Bindestrich? So wie im Titel?
There was a problem hiding this comment.
Wir müssen uns generell überlegen, wie wir es mit der Rechtschreibung handhaben wollen. Ich glaube, dass "API-Design" tatsächlich die korrekte deutsche Schreibweise wäre?!? Mir gefällt das aber auch nicht und ich schreibe es deshalb selbst auch immer ohne Bindestrich. In jedem Fall sollten wir es überall einheitlich schreiben.
In diesem Zusammenhang müssen wir uns ebenfalls einigen, welchen Artikel wir für "API" verwenden. Ich persönlich präferiere "die API", während manche Kolleg:innen aus den Print Medien mir das hartnäckig in "das API" korrigieren...
There was a problem hiding this comment.
"API-Design" finde ich furchtbar, aber vielleicht sagt der Duden ja das muss so sein?
Und das deutsche API. Ich bin Neutrum-Fan. Ist ja nicht extrem weiblich, so ein API. Aber @sippsack, was meinst Du? Mir will scheinen die "die" Variante ist zumindest mal nicht unüblich in Deutschland?
There was a problem hiding this comment.
Ich versehe Deinen Punkt mit dem Neutrum. Unterstützer des Femininums argumentieren, dass API für ......schnittstelle steht. Und in der deutschen Sprache ist es eben "die Schnittstelle". Wie gesagt ist es mir gleich, nur einheitlich sollte es sein.
There was a problem hiding this comment.
Falls es da keine Opposition gibt wäre ich persönlich happy mit "das".
| 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 verstehen, weshalb ein gewissenhaftes Design von API-Schnittstellen von großer Bedeutung ist und welchen Einfluss dies auf die Nutzbarkeit, Wartung, Weiterentwicklung und Verbreitung der Schnittstelle haben wird. |
There was a problem hiding this comment.
API-Schnittstellen -> APIs? Sonst ist es ein bisschen doppelt und fuer mich auch leicht verwirrlich: Hat das API eine Schnittstelle?
| ==== LZ 4-2: API Design als "Outside-in" Ansatz anwenden | ||
|
|
||
| Zu den wichtigsten Zielen von APIs zählt die effiziente Anbindung von Konsumenten an die Schnittstelle des Betreibers. | ||
| Das Design sollte auf die Anforderungen der Konsumenten fokussiert sein und nicht entlang eventuell bestehender Systeme, Use Cases oder Datenbanken. Teilnehmer:innen kennen und verstehen die Ansätze von API First und konsumentengetriebenem API-Design. |
| [[LZ-4-3]] | ||
| ==== LZ 4-3: Offenheit und Erweiterbarkeit als wichtige Aspekte für die Weiterentwicklung von APIs interpretieren | ||
|
|
||
| Teilnehmer:innen kennen Postel's Law, die Bedeutung von Forward und Backward Compatibility und welchen immensen Einfluss diese auf die Möglichkeit der Weiterentwicklung von API-Schnittstellen haben. |
There was a problem hiding this comment.
API-Schnittstellen -> APIs (wie oben)
| [[LZ-4-4]] | ||
| ==== LZ 4-4: Versionierung von APIs verstehen | ||
|
|
||
| Teilnehmer:innen erlangen ein Verständnis für verschiedene Aspekte der Versionierung und wie sie innerhalb des Lebenszyklus eines API Produkts verwendet werden. |
There was a problem hiding this comment.
API Produkt -> API (sonst erscheint hier der Begriff etwas ueberraschend)
| A reference source is referenced via `\<<label>>`. The label has to be defined in `99-references/00-references.adoc`. | ||
| ==== | ||
|
|
||
| <<geewax>> |
There was a problem hiding this comment.
Vielleicht auch noch https://api-patterns.org/book/ ?
No description provided.