Package at.jku.dke.etutor.task_app.config

Class BaseOpenApiConfig

java.lang.Object

at.jku.dke.etutor.task_app.config.BaseOpenApiConfig

public abstract class BaseOpenApiConfig
extends Object

Base class for OpenAPI configuration.

Override this class and add the Configuration annotation to the subclass.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseOpenApiConfig(String title, String description, String version)	Creates a new instance of class BaseOpenApiConfig.

Method Summary

Modifier and Type	Method	Description
io.swagger.v3.oas.models.OpenAPI	customOpenApi()	Provides the Open API information.
protected io.swagger.v3.oas.models.info.Info	openApiInfo()	Provides the OpenAPI information.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BaseOpenApiConfig

protected BaseOpenApiConfig(String title,
 String description,
 String version)

Creates a new instance of class BaseOpenApiConfig.

Parameters:

title - The title of the API documentation.

description - The description of the API.

version - The version of the API.

Method Details

customOpenApi

@Bean
public io.swagger.v3.oas.models.OpenAPI customOpenApi()

Provides the Open API information.

Returns:

The Open API information.

openApiInfo

protected io.swagger.v3.oas.models.info.Info openApiInfo()

Provides the OpenAPI information.

Returns:

The OpenAPI information.