org.sdase.commons.server.openapi

Class OpenApiBundle

java.lang.Object

org.sdase.commons.server.openapi.OpenApiBundle

All Implemented Interfaces:

io.dropwizard.ConfiguredBundle<io.dropwizard.Configuration>

public final class OpenApiBundle
extends java.lang.Object
implements io.dropwizard.ConfiguredBundle<io.dropwizard.Configuration>

A bundle used to generate and serve API-first or code-first OpenAPI 3 files at the openapi.yaml or openapi.json HTTP resources.

Example Usage

Minimal

  @OpenAPIDefinition(info = @Info(title = "An example application"))
  public class ExampleApplication extends Application<Configuration> {

    // ...

    @Override
    public void initialize(Bootstrap<Configuration> bootstrap) {
      // ...
      bootstrap.addBundle(
        OpenApiBundle.builder()
          .addResourcePackageClass(getClass())
          .build());
    }
  }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenApiBundle.Builder
static interface	OpenApiBundle.FinalBuilder
static interface	OpenApiBundle.InitialBuilder

Constructor Summary

Constructors

Constructor and Description
OpenApiBundle(java.util.Set<java.lang.String> resourcePackages, io.swagger.v3.oas.models.OpenAPI existingOpenAPI)

Method Summary

Modifier and Type	Method and Description
static OpenApiBundle.InitialBuilder	builder()
void	initialize(io.dropwizard.setup.Bootstrap<?> bootstrap)
void	run(io.dropwizard.Configuration configuration, io.dropwizard.setup.Environment environment)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiBundle

public OpenApiBundle(java.util.Set<java.lang.String> resourcePackages,
                     io.swagger.v3.oas.models.OpenAPI existingOpenAPI)

Method Detail

builder

public static OpenApiBundle.InitialBuilder builder()

initialize

public void initialize(io.dropwizard.setup.Bootstrap<?> bootstrap)

Specified by:

initialize in interface io.dropwizard.ConfiguredBundle<io.dropwizard.Configuration>

run

public void run(io.dropwizard.Configuration configuration,
                io.dropwizard.setup.Environment environment)

Specified by:

run in interface io.dropwizard.ConfiguredBundle<io.dropwizard.Configuration>