Package org.sdase.commons.server.openapi

Class OpenApiBundle

java.lang.Object

org.sdase.commons.server.openapi.OpenApiBundle

All Implemented Interfaces:

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

public final class OpenApiBundle
extends Object
implements io.dropwizard.core.ConfiguredBundle<io.dropwizard.core.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	Description
static final class	OpenApiBundle.Builder
static interface	OpenApiBundle.FinalBuilder
static interface	OpenApiBundle.InitialBuilder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static OpenApiBundle.InitialBuilder	builder()
String	generateOpenApiAsJson()	This method can be used to generate the OpenAPI specification as JSON
String	generateOpenApiAsYaml()	This method can be used to generate the OpenAPI specification as YAML
void	initialize(io.dropwizard.core.setup.Bootstrap<?> bootstrap)
void	run(io.dropwizard.core.Configuration configuration, io.dropwizard.core.setup.Environment environment)

Methods inherited from class java.lang.Object

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

Constructor Details

OpenApiBundle

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

Method Details

builder

public static OpenApiBundle.InitialBuilder builder()

initialize

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

Specified by:

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

run

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

Specified by:

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

generateOpenApiAsYaml

public String generateOpenApiAsYaml()
                             throws Exception

This method can be used to generate the OpenAPI specification as YAML

Returns:

the OpenAPI specification as YAML

Throws:

Exception

generateOpenApiAsJson

public String generateOpenApiAsJson()
                             throws Exception

This method can be used to generate the OpenAPI specification as JSON

Returns:

the OpenAPI specification as JSON

Throws:

Exception