Skip to content
Snippets Groups Projects
Commit ab6a2184 authored by Eduard Ellert's avatar Eduard Ellert Committed by Tom Käsler
Browse files

Include the Springfox Swagger description part in the CONTRIBUTING.md file

parent 3eb692db
Branches
Tags
No related merge requests found
...@@ -3,3 +3,14 @@ ...@@ -3,3 +3,14 @@
ARSnova needs you! If you are interested in helping, please review the guidelines found in our [mobile repository][mobile-repository]. 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 [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
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment