Java Spring Example

Licensed under the MIT License. See file LICENSE.

Java Spring example. Example includes code written in Java.

Spring Boot

The Swagger UI page is available at

http://localhost:8080/swagger-ui.html

and the OpenAPI description is available at

http://localhost:8080/v3/api-docs

Gradle

Check version with command gradle -v.

Run gradlew wrapper --gradle-version latest to update the project to latest version.

Run gradlew wrapper --gradle-version 7.4.2 to update the project to 7.4.2.

Links

• OpenAPI
  • OpenAPI 3 Library for Spring Boot
  • OpenAPI Initiative (OAI)
  • OpenAPI Spec 3.0.1
  • Swagger Codegen
  • Swagger Editor
  • Swagger Validator
• Testing
  • Cornutum/tcases - A model-based test case generator
  • REST Assured - Testing and validating REST services in Java
  • Testing the Web Layer - Spring Guide
• General
  • GitHub Action Setup Java for use with GitHub CodeQL
  • Gradle Build Tool
  • Gretty - a feature-rich gradle plugin for running web-apps on embedded servlet containers
  • Java Development Examples

Tasks

• Upgrade to latest versions of Java, Spring Boot, Gradle, see Upgrade Guide
• Add Jetty execution in check task before integration tests are run
• Compare generated openapi.yaml and api_v3.yaml
• Add Gradle integration tests
  • https://docs.gradle.org/current/userguide/migrating_from_maven.html#migmvn:build_lifecycle
  • https://docs.gradle.org/current/userguide/migrating_from_maven.html#migmvn:integration_tests
  • https://docs.gradle.org/current/userguide/java_testing.html#sec:configuring_java_integration_tests