Implemented and documented interactive API documentation with Springfox (!4) · Merge requests · ARSnova / ARSnova Backend

Tjark Wilhelm Hoeck requested to merge twhc55/arsnova-backend:swagger_api into master Jun 08, 2015

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.

Implemented and documented interactive API documentation with Springfox

Merge request reports