io.bootique.swagger.SwaggerOpenapiApi 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.core.JsonProcessingException;
import io.swagger.v3.core.util.Json;
import io.swagger.v3.core.util.Yaml;
import io.swagger.v3.oas.annotations.Operation;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;
import java.util.Map;

@Path("_this_is_a_placeholder_that_will_be_replaced_dynamically_")
public class SwaggerOpenapiApi {

    static final String MEDIA_TYPE_JSON = MediaType.APPLICATION_JSON;
    static final String MEDIA_TYPE_YAML= "application/yaml";


    private Map models;

    public SwaggerOpenapiApi(Map models) {
        this.models = models;
    }

    @GET
    @Produces({MEDIA_TYPE_JSON, MEDIA_TYPE_YAML})
    @Operation(hidden = true)
    public Response getOpenApi(@Context UriInfo uriInfo) {

        String path = uriInfo.getPath();
        OpenApiModel model = models.get(path);
        if (model == null) {
            return Response
                    .status(Response.Status.NOT_FOUND)
                    .type(MediaType.TEXT_PLAIN_TYPE)
                    .entity("No model at " + path).build();
        }

        String type = model.getMediaType(path);
        switch (type) {
            case MEDIA_TYPE_JSON:
                return jsonResponse(model);
            case MEDIA_TYPE_YAML:
                return yamlResponse(model);
            default:
                throw new RuntimeException("Should never get here");
        }
    }

    protected Response yamlResponse(OpenApiModel model) {

        return Response.status(Response.Status.OK)
                .entity(printYaml(model))
                .type(MEDIA_TYPE_YAML)
                .build();
    }

    protected Response jsonResponse(OpenApiModel model) {
        return Response.status(Response.Status.OK)
                .entity(printJson(model))
                .type(MEDIA_TYPE_JSON)
                .build();
    }

    protected String printYaml(OpenApiModel model) {
        try {
            return model.isPretty() ? Yaml.pretty(model.getApi()) : Yaml.mapper().writeValueAsString(model.getApi());
        } catch (JsonProcessingException e) {
            throw new RuntimeException("Error converting model to YAML", e);
        }
    }

    protected String printJson(OpenApiModel model) {
        try {
            return model.isPretty() ? Json.pretty(model.getApi()) : Json.mapper().writeValueAsString(model.getApi());
        } catch (JsonProcessingException e) {
            throw new RuntimeException("Error converting model to JSON", e);
        }
    }
}