From 830ef95443d518769b24b522cbc98e55e6cc988f Mon Sep 17 00:00:00 2001 From: Tjark Wilhelm Hoeck <tjark.hoeck@mni.thm.de> Date: Mon, 8 Jun 2015 17:19:10 +0200 Subject: [PATCH] edited and corrected the additional text in contributing.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b1bea5e2..83470016b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,9 +8,9 @@ ARSnova needs you! If you are interested in helping, please review the guideline [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 this case we use the version 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. +In the [Swagger Annotation Overview](https://github.com/swagger-api/swagger-core/wiki/Annotations) the most frequently-used Annotions are listed and described. Please use them in case of creating new REST API endpoints. If you do so, the interactive API documentation will be created automatically by Springfox. In need of additional informations, please visit our [ARSnova Wiki entry](https://wiki.thm.de/ARSnova#Interaktive_Dokumentation_der_REST-API_mit_Springfox.28Swagger.29). 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 +http://localhost:8080/swagger-ui.html -- GitLab