Implemented and documented interactive API documentation with Springfox

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

The SpringFox framework takes care of the automatically build, everytime up-to-date documentation. SpringFox uses Swagger-Core and Swagger UI and is optimizing those frameworks for supporting REST endpoints build with Spring MVC.

Futhermore, the REST API developers should mention, that SpringFox needs several Annotations for displaying the right informations for the endpoints. Please notice our developer documentation in the ARSnova-Wiki.

Thanks for your update! From what I understand your PR should only contain method annotations along with the required configuration steps. Yet, I see a lot of unrelated changes, like adding "not implemented" comments, removing fields, or rewriting conditionals. These changes should be removed from this PR so that we have a clean implementation branch for Swagger.

The unrelated changes (like the "not implemented" comments) were done because of the requirements of our project. In fact this was a student project, we were instructed to search in Sonarqube for technical debts in all files we were working on. Of course we should pay those debts. That's were the unrelated changes come from.

If you wish, I can rewind those changes and make a new PR.

If Swagger and Technical Debt related commits are cleanly separated, you could create a new branch based on the current master, cherry pick the Technical Debt related commits and create a separate merge request. This way these changes will not get lost and we can review them independently from each other.

For this PR, please remove the unrelated changes (use git rebase -i <base of your branch>). You do not need to create a new PR for this branch, it is updated automatically by GitLab after new pushes.

Added developer action required label

Added 1 commit:

• 9463e5e8 - removed all changes for pay technical debts

Because Git gave me tons of merge conflicts with the rebase command, I decided just to add one more commit where all changes for paying the technical debts are removed. (We are all lazy, aren't we?) In case you wan't these "nice to have" changes included, just reroll the head-commit. Furthermore, you can easily review these additional changes, because they are all removed in one commit. Of corse, you have to "think backwards" in this review, but that shouldn't be a problem.

Removed developer action required label

Thanks for your cleanup. I'm ok with the revert commit. This merge request is now very clean and consistent. Please review my other comments, most of them should be easy fixes.

Status changed to closed

Status changed to reopened

Added developer action required label

Added 1 commit:

• 01499083 - deleted position param from models, little other fixes (whitespaces, typos, etc.)

Thank you for the hints. I reviewed your comments and agree with them. See my last commit and the answer on one of your comments for more informations.

Removed developer action required label

Added 1 commit:

• 2e078392 - fix: removed commented out code