com.sitewhere.web.rest.documentation

Class RestDocumentationGenerator

java.lang.Object

com.sitewhere.web.rest.documentation.RestDocumentationGenerator

public class RestDocumentationGenerator
extends Object

Introspects the REST controllers to pull out documentation and generate it into an HTML file.

Author:

Derek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RestDocumentationGenerator.RequestMethodColors Holder object for colors associated with request method;

Constructor Summary

Constructors

Constructor and Description
RestDocumentationGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	createParametersBlock(MethodParameterBreakdown breakdown) Create the table of parameters.
protected static String	createUriBlock(ParsedMethod method, RestDocumentationGenerator.RequestMethodColors colors) Create block that displays REST service URI.
protected static String	generateControllerDocumentation(ParsedController controller) Generate documentation for a single controller.
protected static String	generateNavigation(List<ParsedController> controllers) Add the navigation panel.
protected static void	generateRestDocumentation(List<ParsedController> controllers, File resourcesFolder, String outputFolder) Generate documentation.
protected static RestDocumentationGenerator.RequestMethodColors	getRequestMethodColors(ParsedMethod method) Find colors associated with request method.
static void	main(String[] args)
protected static ParsedController	parseController(Class<?> controller, File resourcesFolder) Parse information for a given controller.
protected static List<ParsedController>	parseControllers(File resourcesFolder) Parse all controllers using the DocumentedController annotation.
protected static void	parseExamples(Method method, ParsedMethod parsedMethod, File resources) Parse examples for method.
protected static ParsedMethod	parseMethod(String baseUri, Method method, File resources) Generate documentation for a documented method.
protected static List<ParsedParameter>	parseParameters(Method method) Parse method parameters.
protected static String	readFile(File file) Read contents of a file into a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestDocumentationGenerator

public RestDocumentationGenerator()

Method Detail

main

public static void main(String[] args)

parseControllers

protected static List<ParsedController> parseControllers(File resourcesFolder)
                                                  throws com.sitewhere.spi.SiteWhereException

Parse all controllers using the DocumentedController annotation.

Parameters:

resourcesFolder -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

generateRestDocumentation

protected static void generateRestDocumentation(List<ParsedController> controllers,
                             File resourcesFolder,
                             String outputFolder)
                                         throws com.sitewhere.spi.SiteWhereException

Generate documentation.

Parameters:

controllers -

resourcesFolder -

outputFolder -

Throws:

com.sitewhere.spi.SiteWhereException

generateNavigation

protected static String generateNavigation(List<ParsedController> controllers)

Add the navigation panel.

Parameters:

controllers -

Returns:

generateControllerDocumentation

protected static String generateControllerDocumentation(ParsedController controller)

Generate documentation for a single controller.

Parameters:

controller -

Returns:

createUriBlock

protected static String createUriBlock(ParsedMethod method,
                    RestDocumentationGenerator.RequestMethodColors colors)

Create block that displays REST service URI.

Parameters:

method -

colors -

Returns:

getRequestMethodColors

protected static RestDocumentationGenerator.RequestMethodColors getRequestMethodColors(ParsedMethod method)

Find colors associated with request method.

Parameters:

method -

Returns:

createParametersBlock

protected static String createParametersBlock(MethodParameterBreakdown breakdown)

Create the table of parameters.

Parameters:

method -

Returns:

parseController

protected static ParsedController parseController(Class<?> controller,
                               File resourcesFolder)
                                           throws com.sitewhere.spi.SiteWhereException

Parse information for a given controller.

Parameters:

controller -

resourcesFolder -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

parseMethod

protected static ParsedMethod parseMethod(String baseUri,
                       Method method,
                       File resources)
                                   throws com.sitewhere.spi.SiteWhereException

Generate documentation for a documented method.

Parameters:

baseUri -

method -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

parseParameters

protected static List<ParsedParameter> parseParameters(Method method)
                                                throws com.sitewhere.spi.SiteWhereException

Parse method parameters.

Parameters:

method -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

parseExamples

protected static void parseExamples(Method method,
                 ParsedMethod parsedMethod,
                 File resources)
                             throws com.sitewhere.spi.SiteWhereException

Parse examples for method.

Parameters:

method -

parsed -

resources -

Throws:

com.sitewhere.spi.SiteWhereException

readFile

protected static String readFile(File file)
                          throws com.sitewhere.spi.SiteWhereException

Read contents of a file into a String.

Parameters:

file -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException