https://github.com/viadee/api-roundtrip-spring-boot
api-roundtrip-spring-boot
https://github.com/viadee/api-roundtrip-spring-boot
Last synced: 8 months ago
JSON representation
api-roundtrip-spring-boot
- Host: GitHub
- URL: https://github.com/viadee/api-roundtrip-spring-boot
- Owner: viadee
- License: bsd-3-clause
- Created: 2021-02-10T08:32:16.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-01T01:56:58.000Z (over 3 years ago)
- Last Synced: 2024-04-14T23:56:15.842Z (about 2 years ago)
- Language: Java
- Size: 104 KB
- Stars: 4
- Watchers: 8
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API Roundtrip Spring Boot Example
## 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
```bash
mvn verify
```
Running the integration tests in the integrationtest sub directory
```bash
mvn verify -P integrationtest
```
### Spring Doc for API Documentation and Generation
[https://springdoc.org/](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](http://localhost:8080/swagger-ui.html)
- OpenAPI File [http://localhost:8080/v3/api-docs](http://localhost:8080/v3/api-docs)
### OpenAPI Generator for API client and integration test generation
[https://openapi-generator.tech/](https://openapi-generator.tech/)