Allgemeine Informationen
Wir haben Flasgger, eine Flask-Erweiterung, benutzt, um die API-Ressourcen zu visualisieren und zur Laufzeit mit ihnen interagieren zu können. Hierfür haben wir folgende import statements in der API verwendet:
from flasgger import Swagger
from flasgger.utils import swag_from.
Mit ein paar Zeilen Code lässt sich die Swagger-UI initialisieren. Wir haben jede Methode, die die API nach außen anbietet, über ein yml-file definiert und diese den Methoden mithilfe von @swag_from(Pfad und Name des yml-files) decorators zugewiesen (siehe nachstehende Abbildung).
Mehr Informationen zu Flasgger erhält man hier:
https://github.com/flasgger/flasgger.
Zur Laufzeit kann die Swagger-UI unter http://localhost:4000/swaggerui/ aufgerufen werden:
Die API-Dokumentation kann zur Laufzeit unter http://localhost:4000/apispec_1.json aufgerufen werden: