org.jooby.apitool

Class ApiTool.Options

java.lang.Object

org.jooby.apitool.ApiTool.Options

Enclosing class:

ApiTool

public static class ApiTool.Options
extends Object

Export options. Control whenever turn off UI, try button or default theme.

Constructor Summary

Constructors

Constructor and Description
Options(String path) Creates a new ApiTool.Options object.

Method Summary

Modifier and Type	Method and Description
ApiTool.Options	disableTryIt() Disable try button.
ApiTool.Options	disableUI() Turn off UI.
ApiTool.Options	redoc() Add ReDoc UI to swagger (has no effects on RAML).
ApiTool.Options	redoc(String path) Add ReDoc UI to swagger (has no effects on RAML).
ApiTool.Options	tagger(Function<RouteMethod,String> tagger) Set a custom tagger (a.k.a as groupBy operator).
ApiTool.Options	theme(String theme) Set default theme.
ApiTool.Options	use(Path file) Set specification file like swagger.json, api.raml, etc...
ApiTool.Options	use(String file) Set specification file like swagger.json, api.raml, etc...

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options(String path)

Creates a new ApiTool.Options object.

Parameters:

path - Path to mount the export tool. Usually /swagger or /raml.

Method Detail

disableUI

public ApiTool.Options disableUI()

Turn off UI.

Returns:

This option.

disableTryIt

public ApiTool.Options disableTryIt()

Disable try button.

Returns:

This option.

theme

public ApiTool.Options theme(String theme)

Set default theme.

Complete list of Swagger theme are available here.

Raml comes with only two themes: light and dark.

Parameters:

theme - Theme name.

Returns:

This options.

use

public ApiTool.Options use(String file)

Set specification file like swagger.json, api.raml, etc... If this file is present the ApiTool module uses it (no source scan occurs).

   use(new ApiTool()
     .swagger(options -> {
       options.use("my-swagger.json");
     });
   );

 

Parameters:

file - Classpath file location.

Returns:

This options.

use

public ApiTool.Options use(Path file)

Set specification file like swagger.json, api.raml, etc... If this file is present the ApiTool module uses it (no source scan occurs).

   use(new ApiTool()
     .swagger(options -> {
       options.use("my-swagger.json");
     });
   );

 

Parameters:

file - External file location.

Returns:

This options.

tagger

public ApiTool.Options tagger(Function<RouteMethod,String> tagger)

Set a custom tagger (a.k.a as groupBy operator). This function creates custom Swagger tags (has no effects on RAML).

Parameters:

tagger - Custom tagger.

Returns:

This options.

redoc

public ApiTool.Options redoc(String path)

Add ReDoc UI to swagger (has no effects on RAML).

Parameters:

path - Redoc base path.

Returns:

This options.

redoc

public ApiTool.Options redoc()

Add ReDoc UI to swagger (has no effects on RAML).

Returns:

This options.