OpenAPI (ktor-API)
Während FastAPI bereits OpenAPI unterstützt, ist dies bei KTOR (noch) nicht der Fall. Es gibt folgende Ansätze für KTOR bzw. IDEA:
- https://plugins.jetbrains.com/plugin/14837-openapi-swagger-editor damit lässt sich z.B. die API mit JSON beschreiben.
- https://medium.com/nerd-for-tech/openapi-generation-with-ktor-d57879ec5ab0
- https://blog.readme.com/how-to-generate-openapi-descriptions/
- https://github.com/papsign/Ktor-OpenAPI-Generator
- https://github.com.cnpmjs.org/1gravity/Ktor-OpenAPI-Generator
Vorarbeiten: #25 (closed)
- Einarbeitung in Swagger bzw. OpenAPI, z.B. mit https://blog.readme.com/how-to-use-openapi-and-swagger-spec-for-documentation/
- Evaluation der verschiedenen Möglichkeiten/Werkzeuge
- Begründete Auswahl eines Werkzeugs
- Dokumentation der API
- Präsentation am 16.6. zu OpenAPI und der konkreten Verwendung in diesem Projekt
Akzeptanzkriterien
- auch zur KTOR-API existiert eine gute Beschreibung auf Basis von OpenAPI