Package org.springdoc.core.providers

Class SpringCloudFunctionProvider

java.lang.Object

org.springdoc.core.providers.SpringCloudFunctionProvider

All Implemented Interfaces:

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

public class SpringCloudFunctionProvider
extends Object
implements CloudFunctionProvider, org.springframework.context.ApplicationContextAware

The type Spring cloud function provider.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor	Description
SpringCloudFunctionProvider(Optional<org.springframework.cloud.function.context.FunctionCatalog> functionCatalogOptional, SpringDocConfigProperties springDocConfigProperties)	Instantiates a new Spring cloud function provider.

Method Summary

Modifier and Type	Method	Description
protected RouterOperation	getRouterFunctionPaths(String beanName, org.springframework.web.bind.annotation.RequestMethod requestMethod)	Gets router function paths.
List<RouterOperation>	getRouterOperations(io.swagger.v3.oas.models.OpenAPI openAPI)	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

Constructor Detail

SpringCloudFunctionProvider

public SpringCloudFunctionProvider(Optional<org.springframework.cloud.function.context.FunctionCatalog> functionCatalogOptional,
                                   SpringDocConfigProperties springDocConfigProperties)

Instantiates a new Spring cloud function provider.

Parameters:

functionCatalogOptional - the function catalog

springDocConfigProperties - the spring doc config properties

Method Detail

getRouterOperations

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

Description copied from interface: CloudFunctionProvider

Gets router operations.

Specified by:

getRouterOperations in interface CloudFunctionProvider

Parameters:

openAPI - the open api

Returns:

the router operations

getRouterFunctionPaths

protected RouterOperation getRouterFunctionPaths(String beanName,
                                                 org.springframework.web.bind.annotation.RequestMethod requestMethod)

Gets router function paths.

Parameters:

beanName - the bean name

requestMethod - the request method

Returns:

the router function paths

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