Skip to content

Interactive API documentation

Daniel Gerhardt requested to merge swagger-api into master

Supersedes !5 (closed).

This feature supports developers with an interactive documentation of the REST API from the ARSnova Backend.

Changes & Todos:

  • Branch & code clean up
    • Rebase on master
    • Squash related commits authored by the same developer
    • Remove commits whose code has been reverted later on
    • Fix whitespaces
  • Remove implementation notes (Java signatures are not helpful)
  • Improve documentation of responses (Tom Käsler)
    • Do not define status messages for methods individually (DRY)
  • Create JSON at compile-time by using swagger-maven-plugin (Tom Käsler)

Merge request reports