com.knappsack.swagger4springweb.parser

Interface ApiParser

All Known Implementing Classes:

ApiParserImpl

public interface ApiParser

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> documentationMap)

Method Detail

getResourceListing

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

Parameters:

documentationMap - 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

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

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.