org.springdoc.core.fn.builders.operation

Class Builder

java.lang.Object

org.springdoc.core.fn.builders.operation.Builder

public class Builder
extends Object

The type Operation builder.

Author:

bnasslahsen

Method Summary

Modifier and Type	Method and Description
Builder	beanClass(Class<?> beanClass) Bean class operation builder.
Builder	beanMethod(String beanMethod) Bean method operation builder.
RouterOperation	build() Build operation.
Builder	deprecated(boolean deprecated) Deprecated operation builder.
Builder	description(String description) Description operation builder.
Builder	extensions(Builder extensionBuilder) Extensions operation builder.
Builder	externalDocs(Builder externalDocumentationBuilder) External docs operation builder.
Builder	hidden(boolean hidden) Hidden operation builder.
Builder	ignoreJsonView(boolean ignoreJsonView) Ignore json view operation builder.
Builder	method(String method) Method operation builder.
static Builder	operationBuilder() Builder operation builder.
Builder	operationId(String operationId) Operation id operation builder.
Builder	parameter(Builder parameterBuilder) Parameter operation builder.
Builder	parameterTypes(Class<?>[] parameterTypes) Parameter types operation builder.
Builder	requestBody(Builder requestBodyBuilder) Request body operation builder.
Builder	response(Builder apiResponseBuilder) Response operation builder.
Builder	security(Builder securityRequirementBuilder) Security operation builder.
Builder	servers(Builder serverBuilder) Servers operation builder.
Builder	summary(String summary) Summary operation builder.
Builder	tag(String tag) Tag operation builder.
Builder	tags(String[] tags) Tags operation builder.

Methods inherited from class java.lang.Object

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

Method Detail

operationBuilder

public static Builder operationBuilder()

Builder operation builder.

Returns:

the operation builder

method

public Builder method(String method)

Method operation builder.

Parameters:

method - the method

Returns:

the operation builder

tags

public Builder tags(String[] tags)

Tags operation builder.

Parameters:

tags - the tags

Returns:

the operation builder

tag

public Builder tag(String tag)

Tag operation builder.

Parameters:

tag - the tag

Returns:

the operation builder

summary

public Builder summary(String summary)

Summary operation builder.

Parameters:

summary - the summary

Returns:

the operation builder

description

public Builder description(String description)

Description operation builder.

Parameters:

description - the description

Returns:

the operation builder

requestBody

public Builder requestBody(Builder requestBodyBuilder)

Request body operation builder.

Parameters:

requestBodyBuilder - the request body builder

Returns:

the operation builder

externalDocs

public Builder externalDocs(Builder externalDocumentationBuilder)

External docs operation builder.

Parameters:

externalDocumentationBuilder - the external documentation builder

Returns:

the operation builder

operationId

public Builder operationId(String operationId)

Operation id operation builder.

Parameters:

operationId - the operation id

Returns:

the operation builder

parameter

public Builder parameter(Builder parameterBuilder)

Parameter operation builder.

Parameters:

parameterBuilder - the parameter builder

Returns:

the operation builder

response

public Builder response(Builder apiResponseBuilder)

Response operation builder.

Parameters:

apiResponseBuilder - the api response builder

Returns:

the operation builder

deprecated

public Builder deprecated(boolean deprecated)

Deprecated operation builder.

Parameters:

deprecated - the deprecated

Returns:

the operation builder

security

public Builder security(Builder securityRequirementBuilder)

Security operation builder.

Parameters:

securityRequirementBuilder - the security requirement builder

Returns:

the operation builder

servers

public Builder servers(Builder serverBuilder)

Servers operation builder.

Parameters:

serverBuilder - the server builder

Returns:

the operation builder

extensions

public Builder extensions(Builder extensionBuilder)

Extensions operation builder.

Parameters:

extensionBuilder - the extension builder

Returns:

the operation builder

hidden

public Builder hidden(boolean hidden)

Hidden operation builder.

Parameters:

hidden - the hidden

Returns:

the operation builder

ignoreJsonView

public Builder ignoreJsonView(boolean ignoreJsonView)

Ignore json view operation builder.

Parameters:

ignoreJsonView - the ignore json view

Returns:

the operation builder

beanClass

public Builder beanClass(Class<?> beanClass)

Bean class operation builder.

Parameters:

beanClass - the bean class

Returns:

the operation builder

beanMethod

public Builder beanMethod(String beanMethod)

Bean method operation builder.

Parameters:

beanMethod - the bean method

Returns:

the operation builder

parameterTypes

public Builder parameterTypes(Class<?>[] parameterTypes)

Parameter types operation builder.

Parameters:

parameterTypes - the parameter types

Returns:

the operation builder

build

public RouterOperation build()

Build operation.

Returns:

the operation