API Definition mit Hilfe von Swagger und YAML

Swagger Installation: npm install -g swagger

Projekt Erstellung: swagger project create <project_name>

Projekt Starten: swagger project start

Projekt editieren: swagger project edit

Die Notation wird innerhalb der OpenAPI Specification festgelegt.
Visuelle Darstellung der Spezifikation von Arnaud Lauret: Link

Definition der API (Ausschnitt):

Download swagger.yaml

YAML Code Verifizieren: swagger project verify

Mock Datei einbinden
In dem Projektordner unter dem Verzeichnis ‚mocks‘ eine neue Mock-Datei erstellen z.B. getAllEntries.js .

Die Mock-Datei muss anschließend innerhalb des Projektes eingebunden werden:

Die API muss wie folgt angepasst werden:

Projekt in Mock Mode starten: swagger project start -m

Postman Ausgabe:

Links:
Online Editor: http://editor.swagger.io

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.