io.openapitools.swagger.config.SwaggerLicense Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swagger-maven-plugin Show documentation

Maven plugin to generate OpenAPI documentation using Swagger.

The newest version!

package io.openapitools.swagger.config;

import io.swagger.v3.oas.models.info.License;

import java.util.Collections;
import java.util.Map;

import org.apache.maven.plugins.annotations.Parameter;

/**
 * Configuring Swagger license.
 */
public class SwaggerLicense {

    /**
     * REQUIRED. The license name used for the API.
     */
    @Parameter(required = true)
    private String name;

    /**
     * A URL to the license used for the API. MUST be in the format of a URL.
     */
    @Parameter
    private String url;
    
    @Parameter
    private Map extensions = Collections.emptyMap();

    public License createLicenseModel() {
        License license = new License();

        if (name != null) {
            license.setName(name);
        }

        if (url != null) {
            license.setUrl(url);
        }
        
        license.setExtensions(extensions);

        return license;
    }
}