beadledom-swagger2

This project provides API documentation via Swagger 2.

Download

Download using Maven:

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

Usage

Install the Swagger2Module 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 Swagger2Module());
    ...
  }

  @Provides
  Info provideSwagger2Info(ServiceMetadata serviceMetadata) {
    return new Info()
      .title("Your Service Title")
      .description("Your Service Description")
      .version(serviceMetadata.getGuildInfo().getVersion());
  }
}