Interactive API documentation

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)

CC: @tksl38

mentioned in merge request !5 (closed)

Added 2 commits:

• 1c07e298 - Clean up code
• be23b488 - Remove implementation notes from API documentation

Added 1 commit:

• 99febdec - replace com.wordnik.swagger with io.swagger

Added 1 commit:

• 485e2246 - remove paragraphes for swagger in contributing.md

Added 1 commit:

• b201921c - change dependency to use swagger.io and not springfox

Maven complains about the variables ${build.directory} and ${version}. They should be replaced:

[WARNING] Some problems were encountered while building the effective model for de.thm.arsnova:arsnova-backend:war:2.3.0-SNAPSHOT
[WARNING] The expression ${build.directory} is deprecated. Please use ${project.build.directory} instead.
[WARNING] The expression ${version} is deprecated. Please use ${project.version} instead.
[WARNING] 
[WARNING] It is highly recommended to fix these problems because they threaten the stability of your build.
[WARNING] 
[WARNING] For this reason, future Maven versions might no longer support building such malformed projects.

Added 1 commit:

• 5a52ec2f - replace swagger-core w/ swagger-annotations

Added 1 commit:

• b7180fa0 - outsource ApiResponse Status Codes Text in Abstract controller

Added 1 commit:

• 77c7140a - remove swagger annotation from feedbackcontroller, coursecontroller and getter a…

Added 1 commit:

• 9077a100 - add basePath for api doc

Added 1 commit:

• 27a363de - change whitespace to tabs, remove unneccessary annotations

Added 30 commits:

• 27a363de...6f81833f - 7 commits from branch master
• 631e7101 - Add Swagger dependencies and configuration
• e54fe98b - Edited tests to support the new EnableWebMvc Annotation from the ExtraConfig fil…
• 923d83ed - SwaggerConfiguration basic configs
• c95a78bb - Finished SwaggerConfiguration class and payed technical debts
• 41a37718 - add swagger documentation
• e0715326 - commented Controller LecutererQuestionController
• bd929355 - ignore needless to show controllers in swagger ui
• 9ae7ccbc - add swagger documentation to Course-Controller
• 7564aac7 - hide deprecated API's and paid technical debts for StatisticsController
• 6332bda9 - add swagger documentation to models
• 3eb692db - added labeled deprecated rest endpoints to api documentation, commentet and incl…
• ab6a2184 - Include the Springfox Swagger description part in the CONTRIBUTING.md file
• 830ef954 - edited and corrected the additional text in contributing.md
• c32a9d09 - deleted position param from models, little other fixes (whitespaces, typos, etc.)
• ed9ed22d - Clean up code
• 3d0e0e5e - Remove implementation notes from API documentation
• eae25a8e - replace com.wordnik.swagger with io.swagger
• b961707c - remove paragraphes for swagger in contributing.md
• 2df937dc - change dependency to use swagger.io and not springfox
• bdd543d0 - outsource ApiResponse Status Codes Text in Abstract controller
• 2435c7e1 - remove swagger annotation from feedbackcontroller, coursecontroller and getter a…
• 1c08728d - add basePath for api doc
• 5da710d9 - change whitespace to tabs, remove unneccessary annotations

Title changed from [WIP] Interactive API documentation to Interactive API documentation

Status changed to merged