org.springdoc.data.rest.core

Class DataRestRequestService

java.lang.Object

org.springdoc.data.rest.core.DataRestRequestService

public class DataRestRequestService
extends Object

The type Data rest request builder.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor and Description
DataRestRequestService(org.springframework.core.LocalVariableTableParameterNameDiscoverer localSpringDocParameterNameDiscoverer, org.springdoc.core.GenericParameterService parameterBuilder, org.springdoc.core.RequestBodyService requestBodyService, org.springdoc.core.AbstractRequestService requestBuilder) Instantiates a new Data rest request builder.

Method Summary

Modifier and Type	Method and Description
void	buildCommonParameters(Class<?> domainType, io.swagger.v3.oas.models.OpenAPI openAPI, org.springframework.web.bind.annotation.RequestMethod requestMethod, org.springdoc.core.MethodAttributes methodAttributes, io.swagger.v3.oas.models.Operation operation, String[] pNames, org.springframework.core.MethodParameter[] parameters) Build common parameters.
io.swagger.v3.oas.models.parameters.Parameter	buildParameterFromDoc(io.swagger.v3.oas.annotations.Parameter parameterDoc, io.swagger.v3.oas.models.Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation) Build parameter from doc parameter.
void	buildParameters(Class<?> domainType, io.swagger.v3.oas.models.OpenAPI openAPI, org.springframework.web.method.HandlerMethod handlerMethod, org.springframework.web.bind.annotation.RequestMethod requestMethod, org.springdoc.core.MethodAttributes methodAttributes, io.swagger.v3.oas.models.Operation operation, org.springframework.data.rest.core.mapping.ResourceMetadata resourceMetadata) Build parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataRestRequestService

public DataRestRequestService(org.springframework.core.LocalVariableTableParameterNameDiscoverer localSpringDocParameterNameDiscoverer,
                              org.springdoc.core.GenericParameterService parameterBuilder,
                              org.springdoc.core.RequestBodyService requestBodyService,
                              org.springdoc.core.AbstractRequestService requestBuilder)

Instantiates a new Data rest request builder.

Parameters:

localSpringDocParameterNameDiscoverer - the local spring doc parameter name discoverer

parameterBuilder - the parameter builder

requestBodyService - the request body builder

requestBuilder - the request builder

Method Detail

buildParameters

public void buildParameters(Class<?> domainType,
                            io.swagger.v3.oas.models.OpenAPI openAPI,
                            org.springframework.web.method.HandlerMethod handlerMethod,
                            org.springframework.web.bind.annotation.RequestMethod requestMethod,
                            org.springdoc.core.MethodAttributes methodAttributes,
                            io.swagger.v3.oas.models.Operation operation,
                            org.springframework.data.rest.core.mapping.ResourceMetadata resourceMetadata)

Build parameters.

Parameters:

domainType - the domain type

openAPI - the open api

handlerMethod - the handler method

requestMethod - the request method

methodAttributes - the method attributes

operation - the operation

resourceMetadata - the resource metadata

buildCommonParameters

public void buildCommonParameters(Class<?> domainType,
                                  io.swagger.v3.oas.models.OpenAPI openAPI,
                                  org.springframework.web.bind.annotation.RequestMethod requestMethod,
                                  org.springdoc.core.MethodAttributes methodAttributes,
                                  io.swagger.v3.oas.models.Operation operation,
                                  String[] pNames,
                                  org.springframework.core.MethodParameter[] parameters)

Build common parameters.

Parameters:

domainType - the domain type

openAPI - the open api

requestMethod - the request method

methodAttributes - the method attributes

operation - the operation

pNames - the p names

parameters - the parameters

buildParameterFromDoc

public io.swagger.v3.oas.models.parameters.Parameter buildParameterFromDoc(io.swagger.v3.oas.annotations.Parameter parameterDoc,
                                                                           io.swagger.v3.oas.models.Components components,
                                                                           com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

Build parameter from doc parameter.

Parameters:

parameterDoc - the parameter doc

components - the components

jsonViewAnnotation - the json view annotation

Returns:

the parameter