io.jooby

Class OpenAPIModule

java.lang.Object

io.jooby.OpenAPIModule

All Implemented Interfaces:

Extension

public class OpenAPIModule
extends Object
implements Extension

OpenAPI supports for Jooby. Basic Usage:

 {
   install(new OpenAPIModule());
 }
 

The [openapi].json and/or [openapi].yaml files must be present on classpath. If jooby-swagger-ui is present (part of your project classpath) swagger-ui will be available. Same for jooby-redoc. Complete documentation is available at: https://jooby.io/modules/openapi

Since:

2.7.0

Author:

edgar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenAPIModule.Format Available formats.

Constructor Summary

Constructors

Constructor and Description
OpenAPIModule() Creates an OpenAPI module.
OpenAPIModule(String path) Creates an OpenAPI module.

Method Summary

Modifier and Type	Method and Description
OpenAPIModule	format(OpenAPIModule.Format... format) Enable what format are available (json or yaml).
void	install(Jooby application) Install, configure additional features to a Jooby application.
OpenAPIModule	redoc(String path) Customize the redoc-ui path.
OpenAPIModule	swaggerUI(String path) Customize the swagger-ui path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jooby.Extension

lateinit

Constructor Detail

OpenAPIModule

public OpenAPIModule(@Nonnull
                     String path)

Creates an OpenAPI module. The path is used to route the open API files. For example:

   install(new OpenAPIModule("/docs"));
 

Files will be at /docs/openapi.json, /docs/openapi.yaml.

Parameters:

path - Custom path to use.

OpenAPIModule

public OpenAPIModule()

Creates an OpenAPI module. Files will be at /openapi.json, /openapi.yaml.

Method Detail

swaggerUI

@Nonnull
public OpenAPIModule swaggerUI(@Nonnull
                                        String path)

Customize the swagger-ui path. Defaults is /swagger.

Parameters:

path - Swagger-ui path.

Returns:

This module.

redoc

@Nonnull
public OpenAPIModule redoc(@Nonnull
                                    String path)

Customize the redoc-ui path. Defaults is /redoc.

Parameters:

path - Redoc path.

Returns:

This module.

format

@Nonnull
public OpenAPIModule format(@Nonnull
                                     OpenAPIModule.Format... format)

Enable what format are available (json or yaml). IMPORTANT: UI tools requires the JSON format.

Parameters:

format - Supported formats.

Returns:

This module.

install

public void install(@Nonnull
                    Jooby application)
             throws Exception

Description copied from interface: Extension

Install, configure additional features to a Jooby application.

Specified by:

install in interface Extension

Parameters:

application - Jooby application.

Throws:

Exception - If something goes wrong.