Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smoketurner/dropwizard-swagger
a Dropwizard bundle that serves Swagger UI static content and loads Swagger endpoints.
https://github.com/smoketurner/dropwizard-swagger
dropwizard dropwizard-swagger java swagger
Last synced: 3 months ago
JSON representation
a Dropwizard bundle that serves Swagger UI static content and loads Swagger endpoints.
- Host: GitHub
- URL: https://github.com/smoketurner/dropwizard-swagger
- Owner: smoketurner
- License: apache-2.0
- Fork: true (federecio/dropwizard-swagger)
- Created: 2015-09-01T11:41:44.000Z (about 9 years ago)
- Default Branch: 4.0.x
- Last Pushed: 2024-05-27T10:08:01.000Z (6 months ago)
- Last Synced: 2024-06-22T18:12:06.175Z (5 months ago)
- Topics: dropwizard, dropwizard-swagger, java, swagger
- Language: Java
- Homepage:
- Size: 27.4 MB
- Stars: 182
- Watchers: 19
- Forks: 101
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-dropwizard - dropwizard-swagger - Serves Swagger UI static content and loads Swagger endpoints. (Open Source / Eclipse)
README
dropwizard-swagger
==================
[](https://travis-ci.org/smoketurner/dropwizard-swagger)
[](https://coveralls.io/github/smoketurner/dropwizard-swagger?branch=master)
[](https://maven-badges.herokuapp.com/maven-central/com.smoketurner/dropwizard-swagger/)
[](https://github.com/smoketurner/dropwizard-swagger/tree/master)
[](https://www.patreon.com/bePatron?u=9567343)
A Dropwizard bundle that serves Swagger UI static content and loads Swagger endpoints. Swagger UI static content is taken from https://github.com/swagger-api/swagger-ui
Current version has been tested with Dropwizard 2.0.0 and Swagger 1.6.0 which supports Swagger 2 spec!
Note: if you come from previous versions there have been some changes in the way the bundle is configured, see details below.
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.x | 0.8.0 | 1.3.12 | v2.1.4-M1 |
| 0.7.x | 0.8.x | 1.5.1-M2 | v2.1.4-M1 |
| 0.7.2 | 0.8.4 | 1.5.3 | v2.1.2 |
| 0.9.x | 0.9.x | 1.5.9 | v2.1.5 |
| 1.0.x | 1.0.x | 1.5.12 | v2.2.10 |
| 1.1.x | 1.1.x | 1.5.16 | v2.2.10 |
| 1.2.x | 1.2.x | 1.5.18 | v3.9.2 |
| 1.3.x | 1.3.x | 1.5.22 | v3.23.0 |
| 2.0.x | 2.0.x | 1.6.0 | v3.24.3 |
How to use it
-------------
* Add the Maven dependency (available in Maven Central)
```xml
com.smoketurner
dropwizard-swagger
2.0.0-1
```
* Add the following to your Configuration class:
```java
public class YourConfiguration extends Configuration {
@JsonProperty("swagger")
public SwaggerBundleConfiguration swaggerBundleConfiguration;
```
* Add the following your configuration yaml (this is the minimal configuration you need):
```yaml
prop1: value1
prop2: value2
# the only required property is resourcePackage, for more config options see below
swagger:
resourcePackage:
```
* In your Application class:
```java
@Override
public void initialize(Bootstrap bootstrap) {
bootstrap.addBundle(new SwaggerBundle() {
@Override
protected SwaggerBundleConfiguration getSwaggerBundleConfiguration(YourConfiguration configuration) {
return configuration.swaggerBundleConfiguration;
}
});
}
```
* As usual, add Swagger annotations to your resource classes and methods
* Open a browser and hit `http://localhost:/swagger`
Additional Swagger configuration
--------------------------------
To see all the properties that can be used to customize Swagger see [SwaggerBundleConfiguration.java](src/main/java/io/federecio/dropwizard/swagger/SwaggerBundleConfiguration.java)
A note on Swagger 2
-------------------
Host and port do not seem to be needed for Swagger 2 to work properly as it uses relative URLs. At the moment I haven't run through all the scenarios so some adjustments might be needed, please open a bug if you encounter any problems.
Contributors
------------
* Federico Recio [@federecio](http://twitter.com/federecio)
* Jochen Szostek [prefabsoft](http://prefabsoft.com)
* Damien Raude-Morvan [drazzib](https://github.com/drazzib)
* Marcel Stör [marcelstoer](https://github.com/marcelstoer)
* Flemming Frandsen [dren-dk](https://github.com/dren-dk)
* Tristan Burch [tburch](https://github.com/tburch)
* Matt Carrier [mattcarrier](https://github.com/mattcarrier)
* Justin Plock [jplock](https://github.com/jplock)
* Ian Rogers [IanRogers-LShift](https://github.com/IanRogers-LShift)