org.restdoc.server.impl

Class RestDocGenerator

java.lang.Object

org.restdoc.server.impl.RestDocGenerator

public class RestDocGenerator
extends Object

Use this class to generate RestDoc

Constructor Summary

Constructors

Constructor and Description
RestDocGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
String	getRestDocStringForPath(String path)
void	init(Class<?>[] classes, org.restdoc.api.GlobalHeader globalHeader, String baseURI) initialize the RestDoc Generator
protected void	parseMethodParameter(List<String> queryParams, Map<String,org.restdoc.api.HeaderDefinition> methodRequestHeader, Map<String,org.restdoc.api.ParamDefinition> methodParams, Type paramType, Annotation[] paramAnnotations)
void	registerGeneratorExtension(IRestDocGeneratorExtension extension)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestDocGenerator

public RestDocGenerator()

Method Detail

init

public void init(Class<?>[] classes,
        org.restdoc.api.GlobalHeader globalHeader,
        String baseURI)

initialize the RestDoc Generator

Parameters:

classes - the array of JAX-RS classes

globalHeader - the global headers

baseURI - an optional base uri like "/api"

parseMethodParameter

protected void parseMethodParameter(List<String> queryParams,
                        Map<String,org.restdoc.api.HeaderDefinition> methodRequestHeader,
                        Map<String,org.restdoc.api.ParamDefinition> methodParams,
                        Type paramType,
                        Annotation[] paramAnnotations)

Parameters:

queryParams -

methodRequestHeader -

methodParams -

paramType -

paramAnnotations -

getRestDocStringForPath

public String getRestDocStringForPath(String path)

Parameters:

path - the basepath to start

Returns:

the RestDoc as string

Throws:

RestDocException - on generation error

registerGeneratorExtension

public void registerGeneratorExtension(IRestDocGeneratorExtension extension)

Parameters:

extension - the IRestDocGeneratorExtension to register