diff options
| author | Manuel Bentele | 2021-12-23 15:13:52 +0100 |
|---|---|---|
| committer | Manuel Bentele | 2021-12-23 15:13:52 +0100 |
| commit | 14e7f8024066253b312b942b8f2f3491b5ef19d8 (patch) | |
| tree | b82e9017832621e24b9ee4952d1e27242a592574 /dozentenmodulserver/api/README.md | |
| parent | [SERVER] Add Maven profile to generate server API automatically (diff) | |
| download | tutor-module-feature/dsmd-openapi.tar.gz tutor-module-feature/dsmd-openapi.tar.xz tutor-module-feature/dsmd-openapi.zip | |
[SERVER] Add source code of autogenerated server APIfeature/dsmd-openapi
Diffstat (limited to 'dozentenmodulserver/api/README.md')
| -rw-r--r-- | dozentenmodulserver/api/README.md | 18 |
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 |