Package springfox.documentation.builders

Class ApiDescriptionBuilder

java.lang.Object

springfox.documentation.builders.ApiDescriptionBuilder

public class ApiDescriptionBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ApiDescriptionBuilder(java.util.Comparator<Operation> operationOrdering)

Method Summary

Modifier and Type	Method	Description
ApiDescription	build()
ApiDescriptionBuilder	description(java.lang.String description)	Updates the descriptions to the api operation
ApiDescriptionBuilder	groupName(java.lang.String groupName)	Updates the group name the api operation belongs to
ApiDescriptionBuilder	hidden(boolean hidden)	Marks the operation as hidden
ApiDescriptionBuilder	operations(java.util.List<Operation> operations)	Updates the operations to the api operation
ApiDescriptionBuilder	path(java.lang.String path)	Updates the path to the api operation
ApiDescriptionBuilder	pathDecorator(java.util.function.Function<java.lang.String,java.lang.String> pathDecorator)
ApiDescriptionBuilder	summary(java.lang.String summary)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDescriptionBuilder

public ApiDescriptionBuilder(java.util.Comparator<Operation> operationOrdering)

Method Detail

path

public ApiDescriptionBuilder path(java.lang.String path)

Updates the path to the api operation

Parameters:

path - - operation path

Returns:

this @see springfox.documentation.builders.ApiDescriptionBuilder

description

public ApiDescriptionBuilder description(java.lang.String description)

Updates the descriptions to the api operation

Parameters:

description - - operation description

Returns:

this @see springfox.documentation.builders.ApiDescriptionBuilder

operations

public ApiDescriptionBuilder operations(java.util.List<Operation> operations)

Updates the operations to the api operation

Parameters:

operations - - operations for each of the http methods for that path

Returns:

this @see springfox.documentation.builders.ApiDescriptionBuilder

hidden

public ApiDescriptionBuilder hidden(boolean hidden)

Marks the operation as hidden

Parameters:

hidden - - operation path

Returns:

this @see springfox.documentation.builders.ApiDescriptionBuilder

pathDecorator

public ApiDescriptionBuilder pathDecorator(java.util.function.Function<java.lang.String,java.lang.String> pathDecorator)

groupName

public ApiDescriptionBuilder groupName(java.lang.String groupName)

Updates the group name the api operation belongs to

Parameters:

groupName - - group this api description belongs to

Returns:

this @see springfox.documentation.builders.ApiDescriptionBuilder

Since:

2.8.1

summary

public ApiDescriptionBuilder summary(java.lang.String summary)

build

public ApiDescription build()