|
|
|
## Allgemeine Informationen
|
|
|
|
|
|
|
|
Wir haben Flasgger 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<br>
|
|
|
|
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 decorators zugewiesen.
|
|
|
|
|
|
|
|
Mehr Informationen zu Flasgger erhält man hier:
|
|
|
|
|
|
|
|
https://github.com/flasgger/flasgger.
|
|
|
|
|
|
|
|
Zur Laufzeit kann man die API-Dokumentation unter http://localhost:4000/swaggerUI/ aufrufen.
|
|
|
|
|
|
|
|
|
