Package org.springdoc.core.providers

Class SpringRepositoryRestResourceProvider

java.lang.Object

org.springdoc.core.providers.SpringRepositoryRestResourceProvider

All Implemented Interfaces:

RepositoryRestResourceProvider, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class SpringRepositoryRestResourceProvider
extends Object
implements RepositoryRestResourceProvider, org.springframework.context.ApplicationContextAware

The type Spring repository rest resource provider.

Author:

bnasslahsen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REPOSITORY_SCHEMA_CONTROLLER	The constant REPOSITORY_SCHEMA_CONTROLLER.

Constructor Summary

Constructors

Constructor	Description
SpringRepositoryRestResourceProvider(DataRestRouterOperationService dataRestRouterOperationService, com.fasterxml.jackson.databind.ObjectMapper mapper, SpringDocDataRestUtils springDocDataRestUtils)	Instantiates a new Spring repository rest resource provider.

Method Summary

Modifier and Type	Method	Description
void	customize(io.swagger.v3.oas.models.OpenAPI openAPI)	Customize.
Map<String,Object>	getBasePathAwareControllerEndpoints()	Gets Base Path Aware controller endpoints.
Map	getHandlerMethods()	Gets handler methods.
List<RouterOperation>	getRouterOperations(io.swagger.v3.oas.models.OpenAPI openAPI, Locale locale)	Gets router operations.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Methods inherited from class java.lang.Object

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

Field Details

REPOSITORY_SCHEMA_CONTROLLER

public static final String REPOSITORY_SCHEMA_CONTROLLER

The constant REPOSITORY_SCHEMA_CONTROLLER.

See Also:

• Constant Field Values

Constructor Details

SpringRepositoryRestResourceProvider

public SpringRepositoryRestResourceProvider(DataRestRouterOperationService dataRestRouterOperationService,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 SpringDocDataRestUtils springDocDataRestUtils)

Instantiates a new Spring repository rest resource provider.

Parameters:

dataRestRouterOperationService - the data rest router operation builder

mapper - the mapper

springDocDataRestUtils - the spring doc data rest utils

Method Details

getRouterOperations

public List<RouterOperation> getRouterOperations(io.swagger.v3.oas.models.OpenAPI openAPI,
 Locale locale)

Gets router operations.

Specified by:

getRouterOperations in interface RepositoryRestResourceProvider

Parameters:

openAPI - the open api

locale - the locale

Returns:

the router operations

getBasePathAwareControllerEndpoints

public Map<String,Object> getBasePathAwareControllerEndpoints()

Gets Base Path Aware controller endpoints.

Specified by:

getBasePathAwareControllerEndpoints in interface RepositoryRestResourceProvider

Returns:

the Base Path Aware controller endpoints

getHandlerMethods

public Map getHandlerMethods()

Gets handler methods.

Specified by:

getHandlerMethods in interface RepositoryRestResourceProvider

Returns:

the handler methods

customize

public void customize(io.swagger.v3.oas.models.OpenAPI openAPI)

Customize.

Specified by:

customize in interface RepositoryRestResourceProvider

Parameters:

openAPI - the open api

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException