|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SwaggerFactory
Factory class for creating Swagger objects and related readers/writers
Method Summary | |
---|---|
ApiDeclaration |
createApiDeclaration(String basePath,
String resourcePath)
Creates an empty ApiDeclaration with the specified basePath and resourcePath |
ResourceListing |
createResourceListing(String basePath)
Creates an empty ResourceListing with the specified basePath to use for resolving contained API declaration references |
SwaggerReader |
createSwaggerReader()
Creates a SwaggerReader that can read Swagger objects |
SwaggerWriter |
createSwaggerWriter(Constants.Format format)
Creates a SwaggerWriter for the specified format |
Method Detail |
---|
ResourceListing createResourceListing(String basePath)
basePath
- the basePath of the ResourceListing
ApiDeclaration createApiDeclaration(String basePath, String resourcePath)
basePath
- used to resolve API paths defined in this declarationresourcePath
- path to the actual resource described in the declaration
SwaggerReader createSwaggerReader()
SwaggerWriter createSwaggerWriter(Constants.Format format)
format
- the format to use when writing, either json or xml
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |