summaryrefslogtreecommitdiffstats
path: root/dozentenmodulserver/api/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'dozentenmodulserver/api/README.md')
-rw-r--r--dozentenmodulserver/api/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/dozentenmodulserver/api/README.md b/dozentenmodulserver/api/README.md
new file mode 100644
index 00000000..00c138a5
--- /dev/null
+++ b/dozentenmodulserver/api/README.md
@@ -0,0 +1,18 @@
+# OpenAPI generated server
+
+Spring Boot Server
+
+
+## Overview
+This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
+By using the [OpenAPI-Spec](https://openapis.org), you can easily generate a server stub.
+This is an example of building a OpenAPI-enabled server in Java using the SpringBoot framework.
+
+The underlying library integrating OpenAPI to SpringBoot is [springfox](https://github.com/springfox/springfox)
+
+Start your server as a simple java application
+
+You can view the api documentation in swagger-ui by pointing to
+http://localhost:9080/
+
+Change default port value in application.properties \ No newline at end of file