Package org.springdoc.data.rest

Class SpringRepositoryRestResourceProvider

java.lang.Object

org.springdoc.data.rest.SpringRepositoryRestResourceProvider

All Implemented Interfaces:

org.springdoc.core.providers.RepositoryRestResourceProvider

public class SpringRepositoryRestResourceProvider
extends Object
implements org.springdoc.core.providers.RepositoryRestResourceProvider

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(org.springframework.data.rest.core.mapping.ResourceMappings mappings, org.springframework.data.repository.support.Repositories repositories, org.springframework.data.rest.webmvc.mapping.Associations associations, org.springframework.context.ApplicationContext applicationContext, DataRestRouterOperationService dataRestRouterOperationService, org.springframework.data.mapping.context.PersistentEntities persistentEntities, 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<org.springdoc.core.fn.RouterOperation>	getRouterOperations(io.swagger.v3.oas.models.OpenAPI openAPI, Locale locale)	Gets router operations.

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(org.springframework.data.rest.core.mapping.ResourceMappings mappings,
 org.springframework.data.repository.support.Repositories repositories,
 org.springframework.data.rest.webmvc.mapping.Associations associations,
 org.springframework.context.ApplicationContext applicationContext,
 DataRestRouterOperationService dataRestRouterOperationService,
 org.springframework.data.mapping.context.PersistentEntities persistentEntities,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 SpringDocDataRestUtils springDocDataRestUtils)

Instantiates a new Spring repository rest resource provider.

Parameters:

mappings - the mappings

repositories - the repositories

associations - the associations

applicationContext - the application context

dataRestRouterOperationService - the data rest router operation builder

persistentEntities - the persistent entities

mapper - the mapper

springDocDataRestUtils - the spring doc data rest utils

Method Details

getRouterOperations

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

Gets router operations.

Specified by:

getRouterOperations in interface org.springdoc.core.providers.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 org.springdoc.core.providers.RepositoryRestResourceProvider

Returns:

the Base Path Aware controller endpoints

getHandlerMethods

public Map getHandlerMethods()

Gets handler methods.

Specified by:

getHandlerMethods in interface org.springdoc.core.providers.RepositoryRestResourceProvider

Returns:

the handler methods

customize

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

Customize.

Specified by:

customize in interface org.springdoc.core.providers.RepositoryRestResourceProvider

Parameters:

openAPI - the open api