com.knappsack.swagger4springweb.parser

Class ApiParserImpl

java.lang.Object

com.knappsack.swagger4springweb.parser.ApiParserImpl

All Implemented Interfaces:

ApiParser

public class ApiParserImpl
extends Object
implements ApiParser

Constructor Summary

Constructors

Constructor and Description
ApiParserImpl(com.wordnik.swagger.model.ApiInfo apiInfo, List<String> baseControllerPackage, String basePath, String servletPath, String apiVersion, List<String> ignorableAnnotations, boolean ignoreUnusedPathVariables, List<Filter> filters)

Method Summary

Modifier and Type	Method and Description
Map<String,com.wordnik.swagger.model.ApiListing>	createApiListings()
com.wordnik.swagger.model.ResourceListing	getResourceListing(Map<String,com.wordnik.swagger.model.ApiListing> apiListingMap)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiParserImpl

public ApiParserImpl(com.wordnik.swagger.model.ApiInfo apiInfo,
                     List<String> baseControllerPackage,
                     String basePath,
                     String servletPath,
                     String apiVersion,
                     List<String> ignorableAnnotations,
                     boolean ignoreUnusedPathVariables,
                     List<Filter> filters)

Method Detail

getResourceListing

public com.wordnik.swagger.model.ResourceListing getResourceListing(Map<String,com.wordnik.swagger.model.ApiListing> apiListingMap)

Specified by:

getResourceListing in interface ApiParser

Parameters:

apiListingMap - Map - A map of different API declarations for which you want to create a resource listing.

Returns:

ResourceListing - This returns a resource listing which is an inventory of all APIs

createApiListings

public Map<String,com.wordnik.swagger.model.ApiListing> createApiListings()

Specified by:

createApiListings in interface ApiParser

Returns:

Map - a map of different API declarations discovered when scanning for classes annotated with @Controller. The key value is the resource path of the API.