Package springfox.documentation.service

Class Documentation

java.lang.Object

springfox.documentation.service.Documentation

public class Documentation
extends java.lang.Object

Constructor Summary

Constructors

Constructor

Description

Documentation(java.lang.String groupName, java.lang.String basePath, java.util.Set<Tag> tags, java.util.Map<java.lang.String,java.util.List<ApiListing>> apiListings, ResourceListing resourceListing, java.util.Set<java.lang.String> produces, java.util.Set<java.lang.String> consumes, java.lang.String host, java.util.Set<java.lang.String> schemes, java.util.Collection<Server> servers, ExternalDocumentation externalDocumentation, java.util.Collection<VendorExtension> vendorExtensions)

Method Summary

Modifier and Type	Method	Description
void	addServer(Server inferredServer)
java.util.Map<java.lang.String,java.util.List<ApiListing>>	getApiListings()
java.lang.String	getBasePath()
java.util.List<java.lang.String>	getConsumes()
ExternalDocumentation	getExternalDocumentation()
java.lang.String	getGroupName()
java.lang.String	getHost()
java.util.List<java.lang.String>	getProduces()
ResourceListing	getResourceListing()
java.util.List<java.lang.String>	getSchemes()
java.util.List<Server>	getServers()
java.util.Set<Tag>	getTags()
java.util.List<VendorExtension>	getVendorExtensions()

Methods inherited from class java.lang.Object

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

Constructor Detail

Documentation

public Documentation(java.lang.String groupName,
                     java.lang.String basePath,
                     java.util.Set<Tag> tags,
                     java.util.Map<java.lang.String,java.util.List<ApiListing>> apiListings,
                     ResourceListing resourceListing,
                     java.util.Set<java.lang.String> produces,
                     java.util.Set<java.lang.String> consumes,
                     java.lang.String host,
                     java.util.Set<java.lang.String> schemes,
                     java.util.Collection<Server> servers,
                     ExternalDocumentation externalDocumentation,
                     java.util.Collection<VendorExtension> vendorExtensions)

Method Detail

getGroupName

public java.lang.String getGroupName()

getApiListings

public java.util.Map<java.lang.String,java.util.List<ApiListing>> getApiListings()

getResourceListing

public ResourceListing getResourceListing()

getTags

public java.util.Set<Tag> getTags()

getBasePath

public java.lang.String getBasePath()

getProduces

public java.util.List<java.lang.String> getProduces()

getHost

public java.lang.String getHost()

getSchemes

public java.util.List<java.lang.String> getSchemes()

getConsumes

public java.util.List<java.lang.String> getConsumes()

getVendorExtensions

public java.util.List<VendorExtension> getVendorExtensions()

getServers

public java.util.List<Server> getServers()

getExternalDocumentation

public ExternalDocumentation getExternalDocumentation()

addServer

public void addServer(Server inferredServer)