io.lighty.swagger

Class SwaggerLighty

java.lang.Object

io.lighty.core.controller.api.AbstractLightyModule

io.lighty.swagger.SwaggerLighty

All Implemented Interfaces:

LightyModule

public class SwaggerLighty
extends AbstractLightyModule

Constructor Summary

Constructors

Constructor and Description
SwaggerLighty(LightyServerBuilder jettyServerBuilder, LightyServices lightyServices)

Method Summary

Modifier and Type	Method and Description
protected boolean	initProcedure() This will register swagger servlet and static ui documentation APIs in LightyServerBuilder.
protected boolean	stopProcedure()

Methods inherited from class io.lighty.core.controller.api.AbstractLightyModule

shutdown, start, startBlocking, startBlocking

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerLighty

public SwaggerLighty(LightyServerBuilder jettyServerBuilder,
                     LightyServices lightyServices)

Method Detail

initProcedure

protected boolean initProcedure()

This will register swagger servlet and static ui documentation APIs in LightyServerBuilder. Swagger URL: http(s)://{hostname:port}/apidoc/apis Swagger UI: http(s)://{hostname:port}/apidoc/explorer/index.html

Specified by:

initProcedure in class AbstractLightyModule

Returns:

true if swagger initialization was successful.

stopProcedure

protected boolean stopProcedure()

Specified by:

stopProcedure in class AbstractLightyModule