OpenAPITools / OpenAPITools/openapi-generator

[REQ] spring generator add Nullable annotations

Open
#17,382 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

Spring provide an @Nullable annotation itself, so this could be used. It'd be nice to generate this along with NotNull for coding assistance and static analysis.

current config

openApiGenerate {
    generatorName = "spring"
    library = "spring-boot"
    inputSpec = "$projectDir/src/main/resources/openapi.json".toString()
    outputDir = layout.buildDirectory.dir("generated/sources/openapi").get().toString()
    library =
        configOptions.putAll([
            openApiNullable        : "false",
            generateApis           : "false",
            generateSupportingFiles: "false",
            serializationLibrary   : "jackson",
            interfaceOnly          : "true",
            annotationLibrary      : "none",
            documentationProvider  : "none",
            useBeanValidation      : "true",
            requestMappingMode     : "none",
            reactive               : "true",
        ])
openapi-generator = { id = "org.openapi.generator", version = "7.0.0" }

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Spring generator entry point and its existing NotNull annotation generation. Check how the spring-boot library and annotationLibrary option affect generated interfaces and models. Done means generated output includes Spring's @Nullable annotations alongside the existing NotNull annotations, with coverage for the relevant generator behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring, spring-boot
Domain
backend-api-design, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.