From ab6a21844b244ed71ee2664ed3745087ffe024d0 Mon Sep 17 00:00:00 2001
From: Eduard Ellert <eduard.ellert@mni.thm.de>
Date: Thu, 4 Jun 2015 16:50:04 +0200
Subject: [PATCH] Include the Springfox Swagger description part in the
 CONTRIBUTING.md file

---
 CONTRIBUTING.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 085a879a7..9b1bea5e2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,3 +3,14 @@
 ARSnova needs you! If you are interested in helping, please review the guidelines found in our [mobile repository][mobile-repository].
 
 [mobile-repository]: https://github.com/thm-projects/arsnova-mobile/blob/master/CONTRIBUTING.md
+
+## Interactive Documentation of the REST API with Springfox(Swagger)
+
+[Springfox](http://springfox.github.io/springfox/docs/current/) automated JSON API documentation for API's built with Spring and 
+supports both version 1.2 and version 2.0 of the [Swagger Specification](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#swagger-restful-api-documentation-specification).
+In this case we use the versionn 2.0 of Swagger. 
+
+In the [Swagger Annotation Overview](https://github.com/swagger-api/swagger-core/wiki/Annotations) the most frequently-used Annotions are listed and described.
+
+To see all REST APIs from ARSnova-Backend, you can use the follow Swagger Userinface URL: 
+http://localhost:8080/swagger-ui.html
\ No newline at end of file
-- 
GitLab