EINZELARBEIT Praktische Übung: OpenAPI-Dokumentation

Gegeben sei der ArtikelService (im Anhang) [oder nach eurem Belieben auch der MovieService], so wie ihr ihn bereits aus dem Fach Informatik her kennt.
  1. Bringt das node.js Express-Projekt auf eurem PC zu laufen
  2. Installiert euch ein REST-Plugin im Browser (bei Firefox die Erweiterung RESTClient) um den Service zu testen. Wenn alles läuft, sollte er auf eine GET-Anfrage unter der Adresse http://localhost:1337/api/artikel reagieren. Studiert den Quelltext und probiert weitere Requests abzusetzen, welche ihr zusammen mit den von euch gemachten Beobachtungen in einem Textdokument festhalten sollt.
  3. Der Dienst ist noch nicht OpenAPI-konform (= Swagger) dokumentiert, so wie ihr es vom OpenDataHub her kennt. OpenAPI ermöglicht es dem Entwickler, APIs auszutesten, aber auch Clientcode auf standardisiertem Wege erzeugen zu lassen. Wählt ein geeignetes Plugin (Bsp. swagger-ui-express) und dokumentiert den Dienst entsprechend (Swagger Editor: https://editor.swagger.io/).
  4. Abschließend entwickelt einen sehr einfachen Black-Box-Test, um die API-Konformität auch bei künftigen Änderungen aufrecht zu erhalten (evtl. mittels der JS-Bibliothek swagger-client).
Abschließend ladet folgende Inhalte hoch:
  1. Der angepasste ArtikelService, welcher OpenAPI-konform dokumentiert wurde (bspw. mittels Swagger)
  2. Den Black-Box-Test als eigenes Projekt
artikel_bilder.zip artikel_bilder.zip
8. Juli 2020, 16:26

Abgabestatus

Abgabestatus Diese Aufgabe benötigt keine Online-Abgabe
Bewertungsstatus Nicht bewertet
Zuletzt geändert -
Abgabekommentare
Kommentare anzeigen