Skip to content

GitLab

  • Menu
Projects Groups Snippets
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
  • I IntentFinder
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 25
    • Issues 25
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • pse-trapp-public
  • IntentFinder
  • Issues
  • #64

Closed
Open
Created May 12, 2021 by Ute Trapp@fbi1119Owner5 of 5 tasks completed5/5 tasks

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
Edited Jun 16, 2021 by Patrick Schlindwein
Assignee
Assign to
Time tracking