beadledom-swagger1

This project provides API documentation via Swagger 1. Additionally the Swagger UI has been updated with an optional field for an Authentication Header.

Download

Download using Maven:

<dependencies>
    ...
    <dependency>
        <groupId>com.cerner.beadledom</groupId>
        <artifactId>beadledom-swagger1</artifactId>
        <version>[Insert latest version]</version>
    </dependency>
    ...
</dependencies>

Usage

Install the SwaggerModule to enable the /api-docs endpoint as well as a /meta/swagger/ui endpoint containing the Swagger ui.

public class MyModule extends AbstractModule {
  ...

  @Override
  protected void configure() {
    ...
    install(new SwaggerModule());
    ...
  }

  @Provides
  SwaggerConfig provideSwaggerConfig(ServiceMetadata serviceMetadata) {
    SwaggerConfig config = new SwaggerConfig();
    config.setApiVersion(serviceMetadata.getBuildInfo().getVersion());
    config.setSwaggerVersion(SwaggerSpec.version());
    return config;
  }
}