org.graylog2.rest.documentation.generator

Class Generator

java.lang.Object

org.graylog2.rest.documentation.generator.Generator

public class Generator
extends 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 String	EMULATED_SWAGGER_VERSION

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and 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 Detail

EMULATED_SWAGGER_VERSION

public static final String EMULATED_SWAGGER_VERSION

See Also:

Constant Field Values

Constructor Detail

Generator

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

Method Detail

generateOverview

public Map<String,Object> generateOverview()

getAnnotatedClasses

public Set<Class<?>> getAnnotatedClasses()

generateForRoute

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