springfox.documentation.builders

Class ResourceListingBuilder

java.lang.Object

springfox.documentation.builders.ResourceListingBuilder

public class ResourceListingBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ResourceListingBuilder()

Method Summary

Modifier and Type	Method and Description
ResourceListingBuilder	apis(java.util.List<ApiListingReference> apis) Updates the api listed within this resource listing
ResourceListingBuilder	apiVersion(java.lang.String apiVersion) Updates the api version
ResourceListing	build()
ResourceListingBuilder	info(ApiInfo info) Updates the api information
ResourceListingBuilder	securitySchemes(java.util.List<? extends SecurityScheme> authorizations) Updates the security definitions that protect this resource listing

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceListingBuilder

public ResourceListingBuilder()

Method Detail

apiVersion

public ResourceListingBuilder apiVersion(java.lang.String apiVersion)

Updates the api version

Parameters:

apiVersion - - api version

Returns:

this

apis

public ResourceListingBuilder apis(java.util.List<ApiListingReference> apis)

Updates the api listed within this resource listing

Parameters:

apis - - apis

Returns:

this

securitySchemes

public ResourceListingBuilder securitySchemes(java.util.List<? extends SecurityScheme> authorizations)

Updates the security definitions that protect this resource listing

Parameters:

authorizations - - security definitions

Returns:

this

info

public ResourceListingBuilder info(ApiInfo info)

Updates the api information

Parameters:

info - - api info~

Returns:

this

build

public ResourceListing build()