com.qdesrame.openapi.diff.OpenApiCompare Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-diff Show documentation
Utility for comparing two OpenAPI specifications.
The newest version!
package com.qdesrame.openapi.diff;

import com.qdesrame.openapi.diff.compare.OpenApiDiff;
import com.qdesrame.openapi.diff.model.ChangedOpenApi;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.parser.OpenAPIV3Parser;
import io.swagger.v3.parser.core.models.AuthorizationValue;
import io.swagger.v3.parser.core.models.ParseOptions;

import java.io.File;
import java.util.List;

public class OpenApiCompare {

    private static OpenAPIV3Parser openApiParser = new OpenAPIV3Parser();
    private static ParseOptions options = new ParseOptions();

    static {
        options.setResolve(true);
    }

    /**
     * compare two openapi doc
     *
     * @param oldContent old api-doc location:Json or Http
     * @param newContent new api-doc location:Json or Http
     * @return Comparison result
     */
    public static ChangedOpenApi fromContents(String oldContent, String newContent) {
        return fromContents(oldContent, newContent, null);
    }

    /**
     * compare two openapi doc
     *
     * @param oldContent old api-doc location:Json or Http
     * @param newContent new api-doc location:Json or Http
     * @param auths
     * @return Comparison result
     */
    public static ChangedOpenApi fromContents(String oldContent, String newContent, List auths) {
        return fromSpecifications(readContent(oldContent, auths), readContent(newContent, auths));
    }

    /**
     * compare two openapi doc
     *
     * @param oldFile old api-doc file
     * @param newFile new api-doc file
     * @return Comparison result
     */
    public static ChangedOpenApi fromFiles(File oldFile, File newFile) {
        return fromFiles(oldFile, newFile, null);
    }

    /**
     * compare two openapi doc
     *
     * @param oldFile old api-doc file
     * @param newFile new api-doc file
     * @param auths
     * @return Comparison result
     */
    public static ChangedOpenApi fromFiles(File oldFile, File newFile, List auths) {
        return fromLocations(oldFile.getAbsolutePath(), newFile.getAbsolutePath(), auths);
    }

    /**
     * compare two openapi doc
     *
     * @param oldLocation old api-doc location (local or http)
     * @param newLocation new api-doc location (local or http)
     * @return Comparison result
     */
    public static ChangedOpenApi fromLocations(String oldLocation, String newLocation) {
        return fromLocations(oldLocation, newLocation, null);
    }

    /**
     * compare two openapi doc
     *
     * @param oldLocation old api-doc location (local or http)
     * @param newLocation new api-doc location (local or http)
     * @param auths
     * @return Comparison result
     */
    public static ChangedOpenApi fromLocations(String oldLocation, String newLocation, List auths) {
        return fromSpecifications(readLocation(oldLocation, auths), readLocation(newLocation, auths));
    }

    /**
     * compare two openapi doc
     *
     * @param oldSpec old api-doc specification
     * @param newSpec new api-doc specification
     * @return Comparison result
     */
    public static ChangedOpenApi fromSpecifications(OpenAPI oldSpec, OpenAPI newSpec) {
        return OpenApiDiff.compare(notNull(oldSpec, "old"), notNull(newSpec, "new"));
    }

    private static OpenAPI notNull(OpenAPI spec, String type) {
        if (spec == null) {
            throw new RuntimeException(String.format("Cannot read %s OpenAPI spec", type));
        }
        return spec;
    }

    private static OpenAPI readContent(String content, List auths) {
        return openApiParser.readContents(content, auths, options).getOpenAPI();
    }

    private static OpenAPI readLocation(String location, List auths) {
        return openApiParser.read(location, auths, options);
    }
}