hostsharing/hs.hsadmin.ng
6
0
Fork 0
Code Pull Requests 3 Activity

add SwaggerUI

Browse Source
This commit is contained in:
Michael Hoennig 2022-08-03 09:06:21 +02:00
parent dc6445544a
commit 5f08b41724
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -60,13 +60,14 @@ If you have at least Docker, the Java JDK and Gradle installed in appropriate ve
-d '{ "prefix":"baa", "reference":80001, "adminUserName":"admin@baa.example.com" }' \ -d '{ "prefix":"baa", "reference":80001, "adminUserName":"admin@baa.example.com" }' \
-X POST http://localhost:8080/api/customers -X POST http://localhost:8080/api/customers
<big>**&#9432;**</big> If you wonder who 'mike@hostsharing.net' and 'sven@hostsharing.net' are and where the data comes from:
'mike@hostsharing.net' and 'sven@hostsharing.net' are Hostsharing hostmaster accounts coming from the example data which is automatically inserted in Testcontainers and Development environments. Mike and Sven are just example Hostsharing hostmaster accounts as part of the example data which is automatically inserted in Testcontainers and Development environments.
Also try for example 'admin@aaa.example.com' or 'unknown@example.org'. Also try for example 'admin@aaa.example.com' or 'unknown@example.org'.
<big>**&#9432;**</big>
If you want a formatted JSON output, you can pipe the result to `jq` or similar. If you want a formatted JSON output, you can pipe the result to `jq` or similar.
And to see the full, currently implemented, API, open http://localhost:8080/swagger-ui/index.html.
If you still need to install some of these tools, find some hints in the next chapters. If you still need to install some of these tools, find some hints in the next chapters.

1
build.gradle
View File

@ -28,6 +28,7 @@ dependencies {
implementation 'org.springframework.boot:spring-boot-starter-hateoas' implementation 'org.springframework.boot:spring-boot-starter-hateoas'
implementation 'org.springframework.boot:spring-boot-starter-jdbc' implementation 'org.springframework.boot:spring-boot-starter-jdbc'
implementation 'org.springframework.boot:spring-boot-starter-web' implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'org.springdoc:springdoc-openapi-ui:1.6.9'
implementation 'org.liquibase:liquibase-core' implementation 'org.liquibase:liquibase-core'
implementation 'org.springframework.data:spring-data-rest-hal-explorer' implementation 'org.springframework.data:spring-data-rest-hal-explorer'
implementation 'com.vladmihalcea:hibernate-types-55:2.17.1' implementation 'com.vladmihalcea:hibernate-types-55:2.17.1'