NickName:Jerry H Ask DateTime:2014-04-26T03:04:00

How to use swagger with dropwizard .0.7.0

I have the latest dropwizard setup. Now I have created a simple API and I am trying to add Swagger on top. There is a Swagger implementation for dropwizard but the sample code is against Yammer dropwizard 0.6.2 which requires addProvider and addResource. The io.dropwizard environment doesn't seem to have this function. Can you please let me know how I can do this under io.dropwizard?

Copyright Notice：Content Author:「Jerry H」，Reproduced under the CC 4.0 BY-SA copyright license with a link to the original source and this disclaimer.
Link to original article：https://stackoverflow.com/questions/23301054/how-to-use-swagger-with-dropwizard-0-7-0

Answers

condit 2014-04-25T19:34:33

For Dropwizard 0.7.0 I configure swagger like this:\n\nvoid configureSwagger(Environment environment) {\n environment.jersey().register(new ApiListingResourceJSON());\n environment.jersey().register(new ApiDeclarationProvider());\n environment.jersey().register(new ResourceListingProvider());\n ScannerFactory.setScanner(new DefaultJaxrsScanner());\n ClassReaders.setReader(new DefaultJaxrsApiReader());\n SwaggerConfig config = ConfigFactory.config();\n config.setApiVersion(API_VERSION);\n config.setBasePath(\"..\" + environment.getApplicationContext().getContextPath());\n}\n\n\nEDIT\n\nTo run Swagger UI with Dropwizard clone the repo and copy the dist directory into src/main/resources/swagger/ (customizing as necessary). Then add the asset bundle like this:\n\n@Override\npublic void initialize(Bootstrap<ApplicationConfiguration> bootstrap) {\n bootstrap.addBundle(new AssetsBundle(\"/swagger/\", \"/docs\", \"index.html\"));\n}\n",

fehguy 2015-02-20T00:24:40

There are some changes for Swagger spec 2.0 that you can see here:\n\nhttps://github.com/swagger-api/swagger-core/tree/develop_2.0/samples/java-dropwizard\n\nNamely the configuration is slightly different:\n\n @Override\n public void run(SwaggerSampleConfiguration configuration, Environment environment) {\n environment.jersey().register(new ApiListingResource());\n\n // specific to the sample\n environment.jersey().register(new PetResource());\n environment.getObjectMapper().setSerializationInclusion(JsonInclude.Include.NON_NULL);\n BeanConfig config = new BeanConfig();\n\n // api specific configuration\n config.setTitle(\"Swagger sample app\");\n config.setVersion(\"1.0.0\");\n config.setResourcePackage(\"com.wordnik.swagger.sample\");\n config.setScan(true);\n }\n",

Matt Stephenson 2016-10-06T13:50:56

Dropwizard 1.0.2, Swagger 1.5.0. Call this from your application's run().\n\nprivate void configureSwagger(Environment environment) {\n BeanConfig magicBean = new BeanConfig();\n magicBean.setVersion(\"0.1\");\n magicBean.setTitle(\"title\");\n magicBean.setBasePath(\"/api\");\n magicBean.setResourcePackage(\"com.me.resources\");\n magicBean.setScan(true);\n environment.jersey().register(new ApiListingResourceJSON());\n environment.jersey().register(new SwaggerSerializers());\n}\n",