io.bootique.swagger.OpenApiLoader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bootique-swagger Show documentation
Provides Swagger-based OpenAPI integration with Bootique and Jersey
There is a newer version: 3.0.M2
/*
 * Licensed to ObjectStyle LLC under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ObjectStyle LLC licenses
 * this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package io.bootique.swagger;

import com.fasterxml.jackson.databind.ObjectMapper;
import io.swagger.v3.core.util.Json;
import io.swagger.v3.core.util.Yaml;
import io.swagger.v3.jaxrs2.Reader;
import io.swagger.v3.jaxrs2.integration.JaxrsAnnotationScanner;
import io.swagger.v3.oas.integration.SwaggerConfiguration;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.Paths;

import javax.ws.rs.core.Application;
import java.io.IOException;
import java.net.URL;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;

/**
 * @since 2.0
 */
public class OpenApiLoader {

    private Application application;

    public OpenApiLoader(Application application) {
        this.application = application;
    }

    public OpenAPI load(List resourcePackages, List resourceClasses, URL specLocation, URL overrideSpecLocation) {

        // override order
        // 1. class annotations
        // 2. spec (overrides annotations)
        // 3. override spec (overrides spec and annotations)

        OpenAPI empty = new OpenAPI();

        OpenAPI specFromAnnotations = !resourcePackages.isEmpty() || !resourceClasses.isEmpty()
                ? loadSpecFromAnnotations(empty, resourcePackages, resourceClasses) : empty;
        OpenAPI spec = specLocation != null ? OpenApiMerger.merge(specFromAnnotations, loadSpec(specLocation)) : specFromAnnotations;
        OpenAPI specOverride = overrideSpecLocation != null ? OpenApiMerger.merge(spec, loadSpec(overrideSpecLocation)) : spec;

        // sort paths for stable specs... OpenAPI loads them in different order depending on the JVM version
        return sortPaths(specOverride);
    }

    protected OpenAPI loadSpecFromAnnotations(OpenAPI mergeInto, List resourcePackages, List resourceClasses) {

        SwaggerConfiguration config = new SwaggerConfiguration();
        config.setOpenAPI(mergeInto);

        if (!resourcePackages.isEmpty()) {
            config.setResourcePackages(new HashSet<>(resourcePackages));
        }

        if (!resourceClasses.isEmpty()) {
            config.setResourceClasses(new HashSet<>(resourceClasses));
        }

        JaxrsAnnotationScanner scanner = new JaxrsAnnotationScanner();
        scanner.setConfiguration(config);
        scanner.setApplication(application);

        Reader reader = new Reader();
        reader.setConfiguration(config);
        reader.setApplication(application);
        return reader.read(scanner.classes(), scanner.resources());
    }

    protected OpenAPI sortPaths(OpenAPI api) {

        Paths paths = api.getPaths();
        if (paths == null) {
            return api;
        }

        String[] keys = paths.keySet().toArray(new String[0]);
        Arrays.sort(keys);

        Paths sorted = new Paths();
        for (String key : keys) {
            sorted.put(key, paths.get(key));
        }

        api.setPaths(sorted);

        return api;
    }

    protected OpenAPI loadSpec(URL location) {

        ObjectMapper mapper = createMapper(location);
        try {
            return mapper.readValue(location, OpenAPI.class);
        } catch (IOException e) {
            throw new RuntimeException("Error reading configuration from " + location, e);
        }
    }

    protected ObjectMapper createMapper(URL location) {
        return location.getFile().toLowerCase().endsWith(".json")
                ? Json.mapper()
                : Yaml.mapper();
    }
}