Package org.onebusaway.watchdog.api

Class RESTEndpointsDocumenter

java.lang.Object

org.onebusaway.watchdog.api.RESTEndpointsDocumenter

public class RESTEndpointsDocumenter
extends Object

Explores the Java classes in a given package, looking for annotations indicating REST endpoints. These are written to an HTML table, documenting basic information about all the known endpoints. Borrowed from http://dalelane.co.uk/blog/?p=1871 Borrowed from http://dalelane.co.uk/blog/?p=1871

Author:

Dale Lane (dale.lane@gmail.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RESTEndpointsDocumenter.Endpoint
class	RESTEndpointsDocumenter.EndpointParameter

Constructor Summary

Constructors

Constructor	Description
RESTEndpointsDocumenter()

Method Summary

Modifier and Type	Method	Description
List<RESTEndpointsDocumenter.Endpoint>	findRESTEndpoints(String basepackage)	Returns REST endpoints defined in Java classes in the specified package.

Methods inherited from class java.lang.Object

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

Constructor Detail

RESTEndpointsDocumenter

public RESTEndpointsDocumenter()

Method Detail

findRESTEndpoints

public List<RESTEndpointsDocumenter.Endpoint> findRESTEndpoints(String basepackage)
                                                         throws IOException,
                                                                ClassNotFoundException

Returns REST endpoints defined in Java classes in the specified package.

Throws:

IOException

ClassNotFoundException