Package org.springdoc.api

Class AbstractMultipleOpenApiResource<R extends AbstractOpenApiResource>

java.lang.Object

org.springdoc.api.AbstractMultipleOpenApiResource<R>

Type Parameters:

R - the type of OpenAPI resource

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public abstract class AbstractMultipleOpenApiResource<R extends AbstractOpenApiResource>
extends Object
implements org.springframework.beans.factory.InitializingBean

The type Abstract multiple open api resource.

Author:

bnasslahsen

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.springframework.beans.factory.ObjectFactory<OpenAPIService>	defaultOpenAPIBuilder	The Default open api builder.
protected final OperationService	operationParser	The Operation parser.
protected final AbstractRequestService	requestBuilder	The Request builder.
protected final GenericResponseService	responseBuilder	The Response builder.
protected final SpringDocConfigProperties	springDocConfigProperties	The Spring doc config properties.
protected final SpringDocProviders	springDocProviders	The Spring doc providers.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMultipleOpenApiResource(List<GroupedOpenApi> groupedOpenApis, org.springframework.beans.factory.ObjectFactory<OpenAPIService> defaultOpenAPIBuilder, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders, SpringDocCustomizers springDocCustomizers)	Instantiates a new Abstract multiple open api resource.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected abstract R	buildOpenApiResource(GroupedOpenApi item)	Build open api resource.
protected R	getOpenApiResourceOrThrow(String group)	Gets open api resource or throw.

Methods inherited from class java.lang.Object

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

Field Details

defaultOpenAPIBuilder

protected final org.springframework.beans.factory.ObjectFactory<OpenAPIService> defaultOpenAPIBuilder

The Default open api builder.

requestBuilder

protected final AbstractRequestService requestBuilder

The Request builder.

responseBuilder

protected final GenericResponseService responseBuilder

The Response builder.

operationParser

protected final OperationService operationParser

The Operation parser.

springDocConfigProperties

protected final SpringDocConfigProperties springDocConfigProperties

The Spring doc config properties.

springDocProviders

protected final SpringDocProviders springDocProviders

The Spring doc providers.

Constructor Details

AbstractMultipleOpenApiResource

protected AbstractMultipleOpenApiResource(List<GroupedOpenApi> groupedOpenApis,
 org.springframework.beans.factory.ObjectFactory<OpenAPIService> defaultOpenAPIBuilder,
 AbstractRequestService requestBuilder,
 GenericResponseService responseBuilder,
 OperationService operationParser,
 SpringDocConfigProperties springDocConfigProperties,
 SpringDocProviders springDocProviders,
 SpringDocCustomizers springDocCustomizers)

Instantiates a new Abstract multiple open api resource.

Parameters:

groupedOpenApis - the grouped open apis

defaultOpenAPIBuilder - the default open api builder

requestBuilder - the request builder

responseBuilder - the response builder

operationParser - the operation parser

springDocConfigProperties - the spring doc config properties

springDocProviders - the spring doc providers

springDocCustomizers - the spring doc customizers

Method Details

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

buildOpenApiResource

protected abstract R buildOpenApiResource(GroupedOpenApi item)

Build open api resource.

Parameters:

item - the grouped open api

Returns:

the open api resource

getOpenApiResourceOrThrow

protected R getOpenApiResourceOrThrow(String group)

Gets open api resource or throw.

Parameters:

group - the group

Returns:

the open api resource or throw