Skip to content

Latest commit

 

History

History
93 lines (63 loc) · 3.66 KB

README.md

File metadata and controls

93 lines (63 loc) · 3.66 KB

dropwizard-swagger

a Dropwizard bundle that serves Swagger UI static content and loads Swagger endpoints. Swagger UI static content is taken from https://github.com/wordnik/swagger-ui

Current version has been tested with Dropwizard 0.8.0 and Swagger 1.3.12

License

http://www.apache.org/licenses/LICENSE-2.0

Version matrix

dropwizard-swagger Dropwizard Swagger API Swagger UI 
 < 0.5        |   0.7.x  |   1.3.2   |    ?
   0.5.x      |   0.7.x  |   1.3.12  | v2.1.4-M1
   0.6        |   0.8.0  |   1.3.12  | v2.1.4-M1

How to use it

  • Add the Maven dependency (available in Maven Central)

      <dependency>
      <groupId>io.federecio</groupId>
      <artifactId>dropwizard-swagger</artifactId>
      <version>0.6</version>
  </dependency>

  • In your Application class:

      @Override
  public void initialize(Bootstrap<YourConfiguration> bootstrap) {
      ...
  	bootstrap.addBundle(new SwaggerBundle<YourConfiguration>());
      ...
  }

  • As usual, add Swagger annotations to your resource classes and methods

  • Open a browser and hit http://localhost:<your_port>/swagger

Sample Application

Take a look at this sample application that shows how to integrate DropWizard and Swagger: dropwizard-swagger-sample-app

Running in AWS

Whether this service is running on AWS is determined by checking for the presence of the folder "/var/lib/cloud". If the folder is actually present then the host Swagger should be bound to is set to the result of a GET request to http://169.254.169.254/latest/meta-data/public-hostname/.

Should the directory /var/lib/cloud not be present the host is set to the result of InetAddress.getLocalHost().getHostName() or localhost.

NOTE: In order to run correctly in AWS, the VPC must have "DNS hostnames" enabled. Otherwise, the call to http://169.254.169.254/latest/meta-data/public-hostname/ will return null.

Manually setting the host name and the port number

Swagger needs to be able to tell the client what hostname and port number to talk to, in the simple case where the user talks directly to the dropwizard process, that's easy, but users often stick a reverse proxy, such as nginx, in front of an application server, so the drop wizard process might listen on localhost:4242 while the client talks to it via nginx on api.example.com:80.

If you need to force swagger to generate urls for a different host and/or port number, then you need to override the getSwaggerBundleConfiguration method to load the host and/or port number from an instance of a SwaggerBundleConfiguration:

	@Override
    public void initialize(Bootstrap<YourConfiguration> bootstrap) {
        ...
        bootstrap.addBundle(new SwaggerBundle<YourConfiguration>() {
            @Override
            public SwaggerBundleConfiguration getSwaggerBundleConfiguration(YourConfigurationClass configuration) {
                return new SwaggerBundleConfiguration("your_host_here", 4242);
            }
        });
        ...
    }

Contributors