|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SwaggerReader
Reads Swagger objects from a URI or a generic SwaggerSource
Method Summary | |
---|---|
ApiDeclaration |
readApiDeclaration(URI uri)
Reads an API Declaration from the specified URI - use this is you have standalone API Declarations. |
ResourceListing |
readResourceListing(SwaggerSource source)
Reads a Resource Listing and all contained API Declarations from the specified SwaggerSource |
ResourceListing |
readResourceListing(URI uri)
Reads a Resource Listing and all contained API Declarations from the specified URI. |
Method Detail |
---|
ResourceListing readResourceListing(URI uri) throws IOException
uri
- the URI of the starting api-docs document (with either json or xml extension)
IOException
ApiDeclaration readApiDeclaration(URI uri) throws IOException
uri
- the URI of the API declaration document (with either json or xml extension)
IOException
ResourceListing readResourceListing(SwaggerSource source) throws IOException
source
- the SwaggerSource providing the Resource Listing and its API Declarations
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |