springfox.documentation.builders

Class ApiListingBuilder

java.lang.Object

springfox.documentation.builders.ApiListingBuilder

public class ApiListingBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ApiListingBuilder(com.google.common.collect.Ordering<ApiDescription> descriptionOrdering) Update the sorting order for api descriptions

Method Summary

Modifier and Type	Method and Description
ApiListingBuilder	apis(java.util.List<ApiDescription> apis) Updates the apis
ApiListingBuilder	apiVersion(java.lang.String apiVersion) Updates the api version
ApiListingBuilder	appendConsumes(java.util.List<java.lang.String> consumes) Appends to the exiting collection of supported media types this listing consumes
ApiListingBuilder	appendProduces(java.util.List<java.lang.String> produces) Appends to the exiting collection of supported media types this listing produces
ApiListingBuilder	availableTags(java.util.Set<Tag> availableTags) Globally configured tags
ApiListingBuilder	basePath(java.lang.String basePath) Updates base path for the api listing
ApiListing	build()
ApiListingBuilder	consumes(java.util.Set<java.lang.String> mediaTypes) Replaces the existing media types with new entries that this documentation consumes
ApiListingBuilder	description(java.lang.String description) Updates the description
ApiListingBuilder	host(java.lang.String host) Updates the host
ApiListingBuilder	models(java.util.Map<java.lang.String,Model> models) Adds to the models collection
ApiListingBuilder	position(int position) Updates the position of the listing
ApiListingBuilder	produces(java.util.Set<java.lang.String> mediaTypes) Replaces the existing media types with new entries that this documentation produces
ApiListingBuilder	protocols(java.util.Set<java.lang.String> protocols) Appends to the exiting collection of supported protocols
ApiListingBuilder	resourcePath(java.lang.String resourcePath) Updates resource path for the api listing
ApiListingBuilder	securityReferences(java.util.List<SecurityReference> securityReferences) Updates the references to the security definitions
ApiListingBuilder	tagNames(java.util.Set<java.lang.String> tagNames) Updates the tags
ApiListingBuilder	tags(java.util.Set<Tag> tags) Updates the tags.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiListingBuilder

public ApiListingBuilder(com.google.common.collect.Ordering<ApiDescription> descriptionOrdering)

Update the sorting order for api descriptions

Parameters:

descriptionOrdering - - ordering for the api descriptions

Method Detail

apiVersion

public ApiListingBuilder apiVersion(java.lang.String apiVersion)

Updates the api version

Parameters:

apiVersion - - api version

Returns:

this

basePath

public ApiListingBuilder basePath(java.lang.String basePath)

Updates base path for the api listing

Parameters:

basePath - - base path

Returns:

this

resourcePath

public ApiListingBuilder resourcePath(java.lang.String resourcePath)

Updates resource path for the api listing

Parameters:

resourcePath - - resource path

Returns:

this

produces

public ApiListingBuilder produces(java.util.Set<java.lang.String> mediaTypes)

Replaces the existing media types with new entries that this documentation produces

Parameters:

mediaTypes - - new media types

Returns:

this

consumes

public ApiListingBuilder consumes(java.util.Set<java.lang.String> mediaTypes)

Replaces the existing media types with new entries that this documentation consumes

Parameters:

mediaTypes - - new media types

Returns:

this

appendProduces

public ApiListingBuilder appendProduces(java.util.List<java.lang.String> produces)

Appends to the exiting collection of supported media types this listing produces

Parameters:

produces - - new media types

Returns:

this

appendConsumes

public ApiListingBuilder appendConsumes(java.util.List<java.lang.String> consumes)

Appends to the exiting collection of supported media types this listing consumes

Parameters:

consumes - - new media types

Returns:

this

host

public ApiListingBuilder host(java.lang.String host)

Updates the host

Parameters:

host - - new host

Returns:

this

protocols

public ApiListingBuilder protocols(java.util.Set<java.lang.String> protocols)

Appends to the exiting collection of supported protocols

Parameters:

protocols - - new protocols

Returns:

this

securityReferences

public ApiListingBuilder securityReferences(java.util.List<SecurityReference> securityReferences)

Updates the references to the security definitions

Parameters:

securityReferences - - security definition references

Returns:

this

apis

public ApiListingBuilder apis(java.util.List<ApiDescription> apis)

Updates the apis

Parameters:

apis - - apis

Returns:

this

models

public ApiListingBuilder models(java.util.Map<java.lang.String,Model> models)

Adds to the models collection

Parameters:

models - - model entries by name

Returns:

this

description

public ApiListingBuilder description(java.lang.String description)

Updates the description

Parameters:

description - - description of the api listing

Returns:

this

position

public ApiListingBuilder position(int position)

Updates the position of the listing

Parameters:

position - - position used to for sorting the listings

Returns:

this

tagNames

public ApiListingBuilder tagNames(java.util.Set<java.lang.String> tagNames)

Updates the tags

Parameters:

tagNames - - just the tag names

Returns:

this

tags

public ApiListingBuilder tags(java.util.Set<Tag> tags)

Updates the tags.

Parameters:

tags - - Tag with name and description

Returns:

- this BREAKING Change in 2.4.0

availableTags

public ApiListingBuilder availableTags(java.util.Set<Tag> availableTags)

Globally configured tags

Parameters:

availableTags - - tags available for services and operations

Returns:

this

build

public ApiListing build()