org.restdoc.server.impl

Interface IRestDocGeneratorExtension

All Known Implementing Classes:

OAuth2Extension, RestDocGeneratorExtensionAdapter

public interface IRestDocGeneratorExtension

Method Summary

Methods

Modifier and Type	Method and Description
void	headerParam(String name, org.restdoc.api.HeaderDefinition definition, Type paramType, AnnotationMap map) invoked for every header parameter
void	newMethod(org.restdoc.api.RestResource restResource, org.restdoc.api.MethodDefinition def, Method method) invoked for every method
void	newResource(org.restdoc.api.RestResource restResource) invoked on every new rest resource
void	newSchema(String schemaURI, org.restdoc.api.Schema s, Class<?> schemaClass) invoked for every used schema class
void	pathParam(String name, org.restdoc.api.ParamDefinition definition, Type paramType, AnnotationMap map) invoked for every path parameter
void	queryParam(String name, org.restdoc.api.ParamDefinition definition, Type paramType, AnnotationMap map) invoked for every query parameter
void	renderDoc(String path, org.restdoc.api.RestDoc doc) invoked of RestDoc generation

Method Detail

newResource

void newResource(org.restdoc.api.RestResource restResource)

invoked on every new rest resource

Parameters:

restResource - the RestResource

queryParam

void queryParam(String name,
              org.restdoc.api.ParamDefinition definition,
              Type paramType,
              AnnotationMap map)

invoked for every query parameter

Parameters:

name - the parameter name

definition - the ParamDefinition

paramType - the Java class of the parameter

map - the map of annotations

pathParam

void pathParam(String name,
             org.restdoc.api.ParamDefinition definition,
             Type paramType,
             AnnotationMap map)

invoked for every path parameter

Parameters:

name - the parameter name

definition - the ParamDefinition

paramType - the Java class of the parameter

map - the map of annotations

headerParam

void headerParam(String name,
               org.restdoc.api.HeaderDefinition definition,
               Type paramType,
               AnnotationMap map)

invoked for every header parameter

Parameters:

name - the parameter name

definition - the HeaderDefinition

paramType - the Java class of the parameter

map - the map of annotations

newMethod

void newMethod(org.restdoc.api.RestResource restResource,
             org.restdoc.api.MethodDefinition def,
             Method method)

invoked for every method

Parameters:

restResource - the super resource

def - the MethodDefinition

method - the Java reflection Method

newSchema

void newSchema(String schemaURI,
             org.restdoc.api.Schema s,
             Class<?> schemaClass)

invoked for every used schema class

Parameters:

schemaURI - the schema URI

s - the Schema

schemaClass - the Java class

renderDoc

void renderDoc(String path,
             org.restdoc.api.RestDoc doc)

invoked of RestDoc generation

Parameters:

path - the requested path

doc - the generated doc