openapi-generator-original/samples/server/petstore/springboot-beanvalidation-no-nullable
Andriy Slobodyanyk cba756ffa6
Adds @Nullable annotation to Spring Boot generator (#20345)
* Adds @Nullable annotation to Spring Boot generator

* issue-14427: [REQ][spring] Null-Safety annotations
* issue-17382: [REQ] spring generator add Nullable annotations

Motivations:
* Have Spring Boot generator client properly annotated for nullability to be able to check code using them with tools like NullAway
* As it is related to Spring then the `org.springframework.lang.Nullable` annotation was chosen to avoid discussion which `@Nullable` one is true one
* `@NonNull` wasn't used as I didn't see much benefit of it. Anyhow, an empty constructor and/or setters allow to put a `null` value there

Modifications:
* Adds nullableAnnotation template to handle nullability annotation on vars
* Adjust pojo templates to use the nullability template
* Adapts tests

Modifications:
* Runs export_docs_generator.sh script to update samples

* samples update

* excludes Spring @Nullable from java-camel

* ones with defaults shouldn't be annotated as @Nullable

* updates samples

* adds AllArgConstructor generation tests

* adds container tests
2025-01-06 20:08:01 +08:00
..

OpenAPI generated server

Spring Boot Server

Overview

This server was generated by the OpenAPI Generator project. By using the OpenAPI-Spec, 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 Spring Boot is springfox. Springfox will generate an OpenAPI v2 (fka Swagger RESTful API Documentation Specification) specification based on the generated Controller and Model classes. The specification is available to download using the following url: http://localhost:80/v2/api-docs/

HEADS-UP: Springfox is deprecated for removal in version 6.0.0 of openapi-generator. The project seems to be no longer maintained (last commit is of Oct 14, 2020). It works with Spring Boot 2.5.x but not with 2.6. Spring Boot 2.5 is supported until 2022-05-19. Users of openapi-generator should migrate to the springdoc documentation provider which is, as an added bonus, OpenAPI v3 compatible.

Start your server as a simple java application

You can view the api documentation in swagger-ui by pointing to http://localhost:80/swagger-ui.html

Change default port value in application.properties