io.swagger.jaxrs.config

Interface ReaderListener

public interface ReaderListener

Listener providing hooks for customizing automatically generated Swagger definitions in a JAX-RS environment. Any classes picked up during the scanning process implementing this interface will be instantiated via newInstance() and invoked before and after generating Swagger definitions, allowing code to add additional data or change the generated definition.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterScan(Reader reader, Swagger swagger) Called after a Swagger definition has been populated from scanned classes.
void	beforeScan(Reader reader, Swagger swagger) Called before the Swagger definition gets populated from scanned classes.

Method Detail

beforeScan

void beforeScan(Reader reader,
              Swagger swagger)

Called before the Swagger definition gets populated from scanned classes. Use this method to pre-process the Swagger definition before it gets populated.

Parameters:

reader - the reader used to read annotations and build the Swagger definition

swagger - the initial swagger definition

afterScan

void afterScan(Reader reader,
             Swagger swagger)

Called after a Swagger definition has been populated from scanned classes. Use this method to post-process Swagger definitions.

Parameters:

reader - the reader used to read annotations and build the Swagger definition

swagger - the configured Swagger definition