swagger-core Documentation

File: README.md Copy Chapter

Swagger Core

NOTE: If you're looking for Swagger Core 1.5.X and OpenAPI 2.0, please refer to 1.5 branch.

NOTE: Since version 2.1.7, Swagger Core also supports the Jakarta namespace. There are a parallel set of artifacts with the -jakarta suffix, providing the same functionality as the unsuffixed (i.e.: javax) artifacts.
Please see the Wiki for more details.

NOTE: Since version 2.2.0 Swagger Core supports OpenAPI 3.1; see this page for details

Swagger Core is a Java implementation of the OpenAPI Specification. Current version supports JAX-RS2 (javax and jakarta namespaces).

Get started with Swagger Core! Copy Chapter

See the guide on getting started with Swagger Core to get started with adding Swagger to your API.

See the Wiki! Copy Chapter

The github wiki contains documentation, samples, contributions, etc. Start there.

Compatibility Copy Chapter

The OpenAPI Specification has undergone several revisions since initial creation in 2010. The Swagger Core project has the following compatibilities with the OpenAPI Specification:

Change History Copy Section

If you're interested in the change history of swagger and the Swagger Core framework, see here.

Starting with version 2.3.0, notable changes and fixes are also documented in CHANGELOG.md.

Prerequisites Copy Section

You need the following installed and available in your $PATH:

• Java 11
• Apache maven 3.0.4 or greater
• Jackson 2.4.5 or greater

To build from source (currently 2.2.55-SNAPSHOT) Copy Section

# first time building locally
mvn -N

Subsequent builds:

mvn install

This will build the modules.

Of course if you don't want to build locally you can grab artifacts from maven central:

https://repo1.maven.org/maven2/io/swagger/core/

Maven BOM Copy Section

The swagger-bom artifact is a Bill of Materials that manages both the javax and Jakarta (-jakarta suffix) artifact families.
Import it once and omit versions on all individual Swagger dependencies.

Note: Maven and Gradle build plugins (swagger-maven-plugin, swagger-gradle-plugin,
swagger-eclipse-transformer-maven-plugin) are intentionally excluded from the BOM.
Plugins are applied via `` or plugins {}, not via <dependencyManagement>,
so including them in the BOM would be misleading and could conflict with the plugin
management section of a consumer's build.

Maven

/* Detailed source-code truncated for AI context efficiency. */

Gradle

dependencies {
    implementation(platform("io.swagger.core.v3:swagger-bom:${swaggerOpenapiv3Version}"))

    // javax artifacts — no version needed
    implementation("io.swagger.core.v3:swagger-annotations")
    implementation("io.swagger.core.v3:swagger-core")

    // Jakarta namespace artifacts — no version needed
    implementation("io.swagger.core.v3:swagger-annotations-jakarta")
    implementation("io.swagger.core.v3:swagger-core-jakarta")
}

Sample Apps Copy Chapter

The samples have moved to a new repository and contain various integrations and configurations.

Security contact Copy Chapter

Please disclose any security-related issues or vulnerabilities by emailing [email protected], instead of using the public issue tracker.

File: modules/swagger-project-jakarta/modules/swagger-maven-plugin-jakarta/transformed/README.md Copy Chapter

Don't delete

Target directory for eclipse transformer plugin; Jakarta EE 9+ artifacts are generated in this directory

File: modules/swagger-maven-plugin/README.md Copy Chapter

swagger-maven-plugin

• Resolves project openAPI specification and saves the result in JSON, YAML or both formats.
  All parameters except outputFileName, outputFormat, skip, encoding and outputPath correspond
  to swagger configuration property with same name.

Jakarta namespace support Copy Chapter

Since version 2.1.7 Swagger Core supports also Jakarta namespace, with a parallel set of artifacts with -jakarta suffix, providing the same functionality as the "standard" javax namespace ones.
Please check Wiki for more details

Both javax and jakarta examples are provided below

Configuration example Copy Chapter

`javax` namespace Copy Section

<groupId>io.swagger.core.v3</groupId>
                <artifactId>swagger-maven-plugin</artifactId>
                <version>2.2.54</version>
                <configuration>
                    <outputFileName>openapi</outputFileName>
                    <outputPath>${project.build.directory}/generatedtest</outputPath>
                    <outputFormat>JSONANDYAML</outputFormat>
                    <resourcePackages>
                        test.petstore
                    </resourcePackages>
                    TRUE
                </configuration>
                <executions>
                    <execution>
                        compile
                        <goals>
                            <goal>resolve</goal>
                        </goals>
                    </execution>
                </executions>
            
        
    
    <dependencies>
        <dependency>
            <groupId>io.swagger.core.v3</groupId>
            <artifactId>swagger-jaxrs2</artifactId>
            <version>2.2.54</version>
        </dependency>

        <dependency>
            <groupId>javax.ws.rs</groupId>
            <artifactId>javax.ws.rs-api</artifactId>
            <version>2.1</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
        </dependency>
    </dependencies>

`jakarta` namespace Copy Section

<groupId>io.swagger.core.v3</groupId>
                <artifactId>swagger-maven-plugin-jakarta</artifactId>
                <version>2.2.54</version>
                <configuration>
                    <outputFileName>openapi</outputFileName>
                    <outputPath>${project.build.directory}/generatedtest</outputPath>
                    <outputFormat>JSONANDYAML</outputFormat>
                    <resourcePackages>
                        test.petstore
                    </resourcePackages>
                    TRUE
                </configuration>
                <executions>
                    <execution>
                        compile
                        <goals>
                            <goal>resolve</goal>
                        </goals>
                    </execution>
                </executions>
            
        
    
    <dependencies>
        <dependency>
            <groupId>io.swagger.core.v3</groupId>
            <artifactId>swagger-jaxrs2-jakarta</artifactId>
            <version>2.2.54</version>
        </dependency>

        <dependency>
            <groupId>jakarta.ws.rs</groupId>
            <artifactId>jakarta.ws.rs-api</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>jakarta.servlet</groupId>
            <artifactId>jakarta.servlet-api</artifactId>
            <version>5.0.0</version>
        </dependency>
    </dependencies>

Configuration example with provided Swagger configuration file Copy Chapter

`javax` namespace Copy Section

<groupId>io.swagger.core.v3</groupId>
               <artifactId>swagger-maven-plugin</artifactId>
               <version>2.2.54</version>
               <configuration>
                   <outputFileName>openapi</outputFileName>
                   <outputPath>${project.build.directory}/generatedtest</outputPath>
                   <configurationFilePath>${project.basedir}/src/main/resources/configurationFile.yaml</configurationFilePath>
               </configuration>
               <executions>
                   <execution>
                       compile
                       <goals>
                           <goal>resolve</goal>
                       </goals>
                   </execution>
               </executions>
           
       
   
   ...

`jakarta` namespace Copy Section

<groupId>io.swagger.core.v3</groupId>
               <artifactId>swagger-maven-plugin-jakarta</artifactId>
               <version>2.2.54</version>
               <configuration>
                   <outputFileName>openapi</outputFileName>
                   <outputPath>${project.build.directory}/generatedtest</outputPath>
                   <configurationFilePath>${project.basedir}/src/main/resources/configurationFile.yaml</configurationFilePath>
               </configuration>
               <executions>
                   <execution>
                       compile
                       <goals>
                           <goal>resolve</goal>
                       </goals>
                   </execution>
               </executions>
           
       
   
   ...

Parameters

Since version 2.0.8, configurationFilePath parameter is available, allowing to specify a path to a swagger configuration file; If single maven configuration parameters (e.g. prettyPrint) are also defined, these will overwrite any value set in configuration file; the same applies to openapiFilePath which takes precedence over openAPI field in configuration file.

Since version 2.1.6, sortOutput parameter is available, allowing to sort object properties and map keys alphabetically.
Since version 2.1.6, objectMapperProcessorClass allows to configure also the ObjectMapper instance used to serialize the resolved OpenAPI
Since version 2.1.9, alwaysResolveAppPath parameter is available, allowing to trigger resolving of Application Path from annotation also not in runtime (e.g. using servlet in separate application, or in maven plugin at build time, etc)
Since version 2.2.12, openapi31 parameter is available, if set to true the resolved spec will be processed into a 3.1.0 specification by resolving according to OAS 3.1 rules
Since version 2.1.15, skipResolveAppPath parameter is available, allowing to skip resolving of Application Path from annotation
Since version 2.2.17, defaultResponseCode parameter is available, allowing to set the code used when resolving responses with no http status code annotation
Since version 2.2.24, schemaResolution parameter is available, allowing to specify how object schemas and object properties within schemas are resolved for OAS 3.0 specification
Since version 2.2.28, openAPIVersion parameter is available, allowing to specify the version of the OpenAPI specification to be used for the resolved spec.
Since version 2.2.29, groupsValidationStrategy parameter is available, allowing to specify the strategy for resolving Validation annotations (never, always, neverIfNoContext).
Since version 2.2.29, validatorProcessorClass parameter is available, allowing to specify a custom validator processor class, implementation of io.swagger.v3.core.util.ValidatorProcessor.

File: modules/swagger-gradle-plugin/README.md Copy Chapter

swagger-gradle-plugin

swagger-gradle-plugin supports gradle 3.2 and higher.

Jakarta namespace support Copy Chapter

Since version 2.1.7 Swagger Core supports also Jakarta namespace, with a parallel set of artifacts with -jakarta suffix, providing the same functionality as the "standard" javax namespace ones.
Please check Wiki for more details

To have gradle plugin use the jakarta namespace artifacts, you need to provide a value to parameter buildClasspath
In many cases it is sufficient to set it to the classpath value, like:

buildClasspath = classpath

Alternatively provide as value a classpath with the following dependencies (replacing the provided javax ones):

• org.apache.commons:commons-lang3:3.20.0
• io.swagger.core.v3:swagger-jaxrs2-jakarta:2.2.9
• jakarta.ws.rs:jakarta.ws.rs-api:3.0.0
• jakarta.servlet:jakarta.servlet-api:5.0.0

Installation Copy Chapter

Gradle 3.2 and higher Copy Section

plugins {
  id "io.swagger.core.v3.swagger-gradle-plugin" version "2.2.54"
}

Gradle 1.x and 2.0 Copy Section

NOTE: Since version 2.0.10 gradle 1.x and 2.x up to 3.1 are not supported.

with versions up to 2.0.9:

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "io.swagger.core.v3:swagger-gradle-plugin:2.2.54"
  }
}

apply plugin: "io.swagger.core.v3.swagger-gradle-plugin"

Tasks Copy Chapter

resolve Copy Section

• Resolves project openAPI specification and saves the result in JSON, YAML or both formats.
  All parameters except outputFileName, outputFormat, classpath, skip, encoding, outputDir and outputPath correspond
  to swagger configuration property with same name.

Example Usage

resolve {
    outputFileName = 'PetStoreAPI'
    outputFormat = 'JSON'
    prettyPrint = 'TRUE'
    classpath = sourceSets.main.runtimeClasspath
    resourcePackages = ['io.test']
    outputDir = file('test')
}

Parameters

Note parameter openApiFile corresponds to config openAPI. It points to a location of a file in YAML or JSON format representing the input spec that will be merged with the resolved spec. Typically used to add Info section, or any other meta data.
An example of such file:

openapi: 3.0.4
info:
  version: '1.0'
  title: Swagger Pet Sample App Config File
    about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net,
    #swagger](http://swagger.io/irc/).  For this sample, you can use the api key
    special-key to test the authorization filters.'
  termsOfService: http://swagger.io/terms/
  contact:
    email: [email protected]
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html

• Since version 2.1.6, sortOutput parameter is available, allowing to sort object properties and map keys alphabetically.
• Since version 2.1.6, objectMapperProcessorClass allows to configure also the ObjectMapper instance used to serialize the resolved OpenAPI
• Since version 2.1.9, alwaysResolveAppPath parameter is available, allowing to trigger resolving of Application Path from annotation also not in runtime (e.g. using servlet in separate application, or in maven plugin at build time, etc)
• Since version 2.2.12, openapi31 parameter is available, if set to true the resolved spec will be processed into a 3.1.0 specification by resolving according to OAS 3.1 rules
• Since version 2.1.15, skipResolveAppPath parameter is available, allowing to skip resolving of Application Path from annotation
• Since version 2.2.17, defaultResponseCode parameter is available, allowing to set the code used when resolving responses with no http status code annotation
• Since version 2.2.24, schemaResolution parameter is available, allowing to specify how object schemas and object properties within schemas are resolved for OAS 3.0 specification
• Since version 2.2.28, openAPIVersion parameter is available, allowing to specify the version of the OpenAPI specification to be used for the resolved spec.
• Since version 2.2.29, groupsValidationStrategy parameter is available, allowing to specify the strategy for resolving Validation annotations (never, always, neverIfNoContext).
• Since version 2.2.29, validatorProcessorClass parameter is available, allowing to specify a custom validator processor class, implementation of io.swagger.v3.core.util.ValidatorProcessor.

File: modules/swagger-eclipse-transformer-maven-plugin/README.md Copy Chapter

Adapted from https://github.com/eclipse/transformer/blob/main/org.eclipse.transformer.maven
not to add the transformed JAR as an attached artifact to the project.

To be replaced with Eclipse original Transformer plugin when/if optional attachment is supported.