org.spincast.plugins.openapi.bottomup.config.SpincastOpenApiBottomUpPluginConfig Maven / Gradle / Ivy
package org.spincast.plugins.openapi.bottomup.config;
import org.spincast.plugins.openapi.bottomup.SpincastOpenApiManager;
import io.swagger.v3.oas.models.OpenAPI;
/**
* Configurations for the Spincast Open API Bottom Up plugin.
*/
public interface SpincastOpenApiBottomUpPluginConfig {
/**
* If this returns true no automatic
* specs are going to be generated from the main
* routes.
*
* It is useful to disable such auto specs when you
* want to specify the full {@link OpenAPI} object
* using {@link SpincastOpenApiManager#setOpenApiBase(OpenAPI)}.
*/
public boolean isDisableAutoSpecs();
/**
* The default consumes content types.
*
* Returning null or an empty
* array will result in a single "*/*"
* content type.
*
* By default, returns "application/json".
*/
public String[] getDefaultConsumesContentTypes();
/**
* The default produces content types.
*
* Returning null or an empty
* array will result in a single "*/*"
* content type.
*
* By default, returns "application/json".
*/
public String[] getDefaultProducesContentTypes();
}