Package springfox.documentation.service

Class ApiListing

java.lang.Object

springfox.documentation.service.ApiListing

public class ApiListing
extends java.lang.Object

Constructor Summary

Constructors

Constructor

Description

ApiListing(java.lang.String apiVersion, java.lang.String basePath, java.lang.String resourcePath, java.util.Set<java.lang.String> produces, java.util.Set<java.lang.String> consumes, java.lang.String host, java.util.Set<java.lang.String> protocols, java.util.List<SecurityReference> securityReferences, java.util.List<ApiDescription> apis, java.util.Map<java.lang.String,Model> models, java.util.Map<java.lang.String,ModelSpecification> modelSpecifications, ModelNamesRegistry modelNamesRegistry, java.lang.String description, int position, java.util.Set<Tag> tags)

Method Summary

Modifier and Type	Method	Description
java.util.List<ApiDescription>	getApis()
java.lang.String	getApiVersion()
java.lang.String	getBasePath()
java.util.Set<java.lang.String>	getConsumes()
java.lang.String	getDescription()
java.lang.String	getHost()
ModelNamesRegistry	getModelNamesRegistry()
java.util.Map<java.lang.String,Model>	getModels()
java.util.Map<java.lang.String,ModelSpecification>	getModelSpecifications()
int	getPosition()
java.util.Set<java.lang.String>	getProduces()
java.util.Set<java.lang.String>	getProtocols()
java.lang.String	getResourcePath()
java.util.List<SecurityReference>	getSecurityReferences()
java.util.Set<Tag>	getTags()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiListing

public ApiListing(java.lang.String apiVersion,
                  java.lang.String basePath,
                  java.lang.String resourcePath,
                  java.util.Set<java.lang.String> produces,
                  java.util.Set<java.lang.String> consumes,
                  java.lang.String host,
                  java.util.Set<java.lang.String> protocols,
                  java.util.List<SecurityReference> securityReferences,
                  java.util.List<ApiDescription> apis,
                  java.util.Map<java.lang.String,Model> models,
                  java.util.Map<java.lang.String,ModelSpecification> modelSpecifications,
                  ModelNamesRegistry modelNamesRegistry,
                  java.lang.String description,
                  int position,
                  java.util.Set<Tag> tags)

Method Detail

getApiVersion

public java.lang.String getApiVersion()

getBasePath

public java.lang.String getBasePath()

getResourcePath

public java.lang.String getResourcePath()

getProduces

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

getConsumes

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

getHost

public java.lang.String getHost()

getProtocols

public java.util.Set<java.lang.String> getProtocols()

getSecurityReferences

public java.util.List<SecurityReference> getSecurityReferences()

getApis

public java.util.List<ApiDescription> getApis()

getModels

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

getDescription

public java.lang.String getDescription()

getPosition

public int getPosition()

getTags

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

getModelSpecifications

public java.util.Map<java.lang.String,ModelSpecification> getModelSpecifications()

getModelNamesRegistry

public ModelNamesRegistry getModelNamesRegistry()