API-Dokumentation optimieren und automatisieren

Als User möchte ich, dass ich in allen Klassen-Definitionen die Docstrings geprüfet und ggf. die Attributes ergänzt werden, damit diese in der Doku auftauchen und dies die Nutzung und Konfiguration des Services vereinfacht.

Minimum in src/models/api_input.py und src/models/api_output.py damit die API-Doku klarer werden kann.

Außerdem möchte ich eine openAls Nachnutzer/Entwickler möchte ich eine optimierte und automatisierte Dokumentation der REST API-Endpunkte, damit die Nutzung Außerdem möchte ich eine openapi.json` erstellen und ablegen, um die API-Doku zu optimieren und die Nachnutzung und das Deployment zu vereinfachen.

Außerdem möchte ich, dass in allen Klassen-Definitionen die Docstrings geprüft und ggf. die Attributes ergänzt werden, damit diese in der Doku auftauchen und dies die Nutzung und Konfiguration des Services vereinfacht. Minimum in src/models/api_input.py und src/models/api_output.py damit die API-Doku klarer werden kann.

Akzeptanzkriterien

  • keine Docstrings von class-Definitonen ohne Attributes
  • Beispiele in den Input- und Output-Klassen eingefügt
  • API-Dokumentation durch Befüllen der Dekoratoren optimiert
  • openapi.json erstellt und in root-Verzeichnis abgelegt
  • Review einer zweiten Person durchgeführtapi.json` erstellen und ablegen, um die API-Doku zu optimieren.
Edited by David Moch
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information