Package org.graylog2.shared.rest.documentation.generator

Class Generator

java.lang.Object

org.graylog2.shared.rest.documentation.generator.Generator

public class Generator
extends Object

This is generating API information in Swagger format. We decided to write this ourselves and not to use the Swagger JAX-RS/Jersey integration because it was not compatible to Jersey2 at that point and just way too complicated and too big for what we want to do with it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Generator.Parameter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLOUD_VISIBLE
static final String	EMULATED_SWAGGER_VERSION

Constructor Summary

Constructors

Constructor	Description
Generator(Set<Class<?>> resourceClasses, com.fasterxml.jackson.databind.ObjectMapper mapper, boolean isCloud)
Generator(Set<Class<?>> resourceClasses, Map<Class<?>,String> pluginMapping, String pluginPathPrefix, com.fasterxml.jackson.databind.ObjectMapper mapper, boolean isCloud)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	generateForRoute(String route, String basePath)
Map<String,Object>	generateOverview()
Set<Class<?>>	getAnnotatedClasses()

Methods inherited from class java.lang.Object

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

Field Details

EMULATED_SWAGGER_VERSION

public static final String EMULATED_SWAGGER_VERSION

See Also:

• Constant Field Values

CLOUD_VISIBLE

public static final String CLOUD_VISIBLE

See Also:

• Constant Field Values

Constructor Details

Generator

public Generator(Set<Class<?>> resourceClasses,
 Map<Class<?>,String> pluginMapping,
 String pluginPathPrefix,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 boolean isCloud)

Generator

public Generator(Set<Class<?>> resourceClasses,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 boolean isCloud)

Method Details

generateOverview

public Map<String,Object> generateOverview()

getAnnotatedClasses

public Set<Class<?>> getAnnotatedClasses()

generateForRoute

public Map<String,Object> generateForRoute(String route,
 String basePath)