README.md

API Roundtrip Spring Boot Example

Documentation

https://blog.viadee.de/rest-api-roundtrip

API

A REST-full API server provided as Spring Boot application. The Application makes use of automated tools for documenting and generating OpenAPI specifications and Swagger UIs for comfortable user access based.

Tool Chain Execution

Running the full build cycle for OpenAPI and client/integration test generation with maven from the repositories base directory

mvn verify

Running the integration tests in the integrationtest sub directory

mvn verify -P integrationtest

Spring Doc for API Documentation and Generation

https://springdoc.org/
Annotation based documentation for REST APIs implemented with Spring Web/Rest.

When the application is running, there is a browser access for

• SWAGGER UI http://localhost:8080/swagger-ui.html
• OpenAPI File http://localhost:8080/v3/api-docs

OpenAPI Generator for API client and integration test generation

https://openapi-generator.tech/