Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Privacy
    • Imprint
    • Contact
    • Login methods
  • Sign in
  • ARSnova Backend ARSnova Backend
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 27
    • Issues 27
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 1
    • Merge requests 1
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • ARSnovaARSnova
  • ARSnova BackendARSnova Backend
  • Merge requests
  • !10

Interactive API documentation

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Daniel Gerhardt requested to merge swagger-api into master Aug 06, 2015
  • Overview 3
  • Commits 23
  • Pipelines 0
  • Changes

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)
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: swagger-api