org.openapitools.codegen.utils.ExamplesUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-generator Show documentation
The newest version!
package org.openapitools.codegen.utils;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.examples.Example;
import io.swagger.v3.oas.models.media.Content;
import io.swagger.v3.oas.models.responses.ApiResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.*;

import static org.openapitools.codegen.utils.OnceLogger.once;

public class ExamplesUtils {
    private static final Logger LOGGER = LoggerFactory.getLogger(ExamplesUtils.class);

    /**
     * Return examples of API response.
     *
     * @param openAPI OpenAPI spec.
     * @param response ApiResponse of the operation
     * @return examples of API response
     */
    public static Map getExamplesFromResponse(OpenAPI openAPI, ApiResponse response) {
        ApiResponse result = ModelUtils.getReferencedApiResponse(openAPI, response);
        if (result == null) {
            return Collections.emptyMap();
        } else {
            return getExamplesFromContent(result.getContent());
        }
    }

    private static Map getExamplesFromContent(Content content) {
        if (content == null || content.isEmpty())
            return Collections.emptyMap();

        if (content.containsKey("application/json")) {
            Map examples = content.get("application/json").getExamples();
            if (content.size() > 1 && examples != null && !examples.isEmpty()) {
                once(LOGGER).warn("More than one content media type found in response. Only response examples of the application/json will be taken for codegen.");
            }

            return examples;
        }

        once(LOGGER).warn("No application/json content media type found in response. Response examples can currently only be generated for application/json media type.");

        return Collections.emptyMap();
    }


    /**
     * Return actual examples objects of API response with values and processed from references (unaliased)
     *
     * @param openapi OpenAPI spec.
     * @param apiRespExamples examples of API response
     * @return unaliased examples of API response
     */
    public static List> unaliasExamples(OpenAPI openapi, Map apiRespExamples) {
        Map actualComponentsExamples = getAllExamples(openapi);

        List> result = new ArrayList<>();
        for (Map.Entry example : apiRespExamples.entrySet()) {
            try {
                Map exampleRepr = new LinkedHashMap<>();
                String exampleName = ModelUtils.getSimpleRef(example.getValue().get$ref());

                // api response example can both be a reference and specified directly in the code
                // if the reference is null, we get the value directly from the example -- no unaliasing is needed
                // if it isn't, we get the value from the components examples
                Object exampleValue;
                if(example.getValue().get$ref() != null) {
                    exampleValue = actualComponentsExamples.get(exampleName).getValue();
                    LOGGER.debug("Unaliased example value from components examples: {}", exampleValue);
                } else {
                    exampleValue = example.getValue().getValue();
                    LOGGER.debug("Retrieved example value directly from the api response example definition: {}", exampleValue);
                }

                exampleRepr.put("exampleName", exampleName);
                exampleRepr.put("exampleValue", new ObjectMapper().writeValueAsString(exampleValue)
                        .replace("\"", "\\\""));

                result.add(exampleRepr);
            } catch (JsonProcessingException e) {
                LOGGER.error("Failed to serialize example value", e);
                throw new RuntimeException(e);
            }
        }

        return result;
    }

    private static Map getAllExamples(OpenAPI openapi) {
        return openapi.getComponents().getExamples();
    }
}