org.graylog2.rest.documentation.generator

Class Generator

java.lang.Object

org.graylog2.rest.documentation.generator.Generator

public class Generator
extends java.lang.Object

This is generating API information in Swagger format. http://swagger.wordnik.com/ We decided to write this ourselves and not to use the Swagger JAXRS/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.

Author:

Lennart Koopmann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Generator.DefaultNamingStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMULATED_SWAGGER_VERSION

Constructor Summary

Constructors

Constructor and Description
Generator(java.lang.String packageName, com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

EMULATED_SWAGGER_VERSION

public static final java.lang.String EMULATED_SWAGGER_VERSION

See Also:

Constant Field Values

Constructor Detail

Generator

public Generator(java.lang.String packageName,
                 com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Detail

generateOverview

public java.util.Map<java.lang.String,java.lang.Object> generateOverview()

getAnnotatedClasses

public java.util.Set<java.lang.Class<?>> getAnnotatedClasses()

generateForRoute

public java.util.Map<java.lang.String,java.lang.Object> generateForRoute(java.lang.String route,
                                                                         java.lang.String basePath)