{"id":13805673,"url":"https://github.com/smoketurner/dropwizard-swagger","last_synced_at":"2025-05-13T19:31:48.904Z","repository":{"id":1772705,"uuid":"41735099","full_name":"smoketurner/dropwizard-swagger","owner":"smoketurner","description":"a Dropwizard bundle that serves Swagger UI static content and loads Swagger endpoints.","archived":false,"fork":true,"pushed_at":"2024-07-08T10:57:52.000Z","size":28778,"stargazers_count":182,"open_issues_count":7,"forks_count":100,"subscribers_count":19,"default_branch":"4.0.x","last_synced_at":"2024-08-04T01:05:19.589Z","etag":null,"topics":["dropwizard","dropwizard-swagger","java","swagger"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"federecio/dropwizard-swagger","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smoketurner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"github":"jplock","patreon":"jplock","open_collective":null,"ko_fi":null,"tidelift":null,"custom":null}},"created_at":"2015-09-01T11:41:44.000Z","updated_at":"2024-08-04T01:05:19.590Z","dependencies_parsed_at":"2023-07-05T19:34:24.187Z","dependency_job_id":null,"html_url":"https://github.com/smoketurner/dropwizard-swagger","commit_stats":null,"previous_names":[],"tags_count":56,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smoketurner%2Fdropwizard-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smoketurner%2Fdropwizard-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smoketurner%2Fdropwizard-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smoketurner%2Fdropwizard-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smoketurner","download_url":"https://codeload.github.com/smoketurner/dropwizard-swagger/tar.gz/refs/heads/4.0.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225254368,"owners_count":17445171,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dropwizard","dropwizard-swagger","java","swagger"],"created_at":"2024-08-04T01:01:03.697Z","updated_at":"2024-11-18T21:31:33.114Z","avatar_url":"https://github.com/smoketurner.png","language":"Java","funding_links":["https://github.com/sponsors/jplock","https://patreon.com/jplock","https://www.patreon.com/bePatron?u=9567343"],"categories":["Open Source"],"sub_categories":["Eclipse"],"readme":"dropwizard-swagger\n==================\n[![Build Status](https://travis-ci.org/smoketurner/dropwizard-swagger.svg?branch=master)](https://travis-ci.org/smoketurner/dropwizard-swagger)\n[![Coverage Status](https://coveralls.io/repos/smoketurner/dropwizard-swagger/badge.svg?branch=master\u0026service=github)](https://coveralls.io/github/smoketurner/dropwizard-swagger?branch=master)\n[![Maven Central](https://img.shields.io/maven-central/v/com.smoketurner/dropwizard-swagger.svg?style=flat-square)](https://maven-badges.herokuapp.com/maven-central/com.smoketurner/dropwizard-swagger/)\n[![GitHub license](https://img.shields.io/github/license/smoketurner/dropwizard-swagger.svg?style=flat-square)](https://github.com/smoketurner/dropwizard-swagger/tree/master)\n[![Become a Patron](https://img.shields.io/badge/Patron-Patreon-red.svg)](https://www.patreon.com/bePatron?u=9567343)\n\nA 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\n\nCurrent version has been tested with Dropwizard 2.0.0 and Swagger 1.6.0 which supports Swagger 2 spec!\n\nNote: if you come from previous versions there have been some changes in the way the bundle is configured, see details below.\n\nLicense\n-------\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nVersion matrix\n--------------\n\n| dropwizard-swagger | Dropwizard | Swagger API | Swagger UI |\n|--------------------|------------|-------------|------------|\n| \u003c 0.5              | 0.7.x      | 1.3.2       | ?          |\n| 0.5.x              | 0.7.x      | 1.3.12      | v2.1.4-M1  |\n| 0.6.x              | 0.8.0      | 1.3.12      | v2.1.4-M1  |\n| 0.7.x              | 0.8.x      | 1.5.1-M2    | v2.1.4-M1  |\n| 0.7.2              | 0.8.4      | 1.5.3       | v2.1.2     |\n| 0.9.x              | 0.9.x      | 1.5.9       | v2.1.5     |\n| 1.0.x              | 1.0.x      | 1.5.12      | v2.2.10    |\n| 1.1.x              | 1.1.x      | 1.5.16      | v2.2.10    |\n| 1.2.x              | 1.2.x      | 1.5.18      | v3.9.2     |\n| 1.3.x              | 1.3.x      | 1.5.22      | v3.23.0    |\n| 2.0.x              | 2.0.x      | 1.6.0       | v3.24.3    |\n\nHow to use it\n-------------\n\n* Add the Maven dependency (available in Maven Central)\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.smoketurner\u003c/groupId\u003e\n    \u003cartifactId\u003edropwizard-swagger\u003c/artifactId\u003e\n    \u003cversion\u003e2.0.0-1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n\n* Add the following to your Configuration class:\n\n```java\npublic class YourConfiguration extends Configuration {\n\n    @JsonProperty(\"swagger\")\n    public SwaggerBundleConfiguration swaggerBundleConfiguration;\n```\n\n* Add the following your configuration yaml (this is the minimal configuration you need):\n\n```yaml\nprop1: value1\nprop2: value2\n\n# the only required property is resourcePackage, for more config options see below\nswagger:\n  resourcePackage: \u003ca comma separated string of the packages that contain your @Api annotated resources\u003e\n```\n\n* In your Application class:\n\n```java\n@Override\npublic void initialize(Bootstrap\u003cYourConfiguration\u003e bootstrap) {\n    bootstrap.addBundle(new SwaggerBundle\u003cYourConfiguration\u003e() {\n        @Override\n        protected SwaggerBundleConfiguration getSwaggerBundleConfiguration(YourConfiguration configuration) {\n            return configuration.swaggerBundleConfiguration;\n        }\n    });\n}\n```\n\n* As usual, add Swagger annotations to your resource classes and methods\n\n* Open a browser and hit `http://localhost:\u003cyour_port\u003e/swagger`\n\nAdditional Swagger configuration\n--------------------------------\n\nTo see all the properties that can be used to customize Swagger see [SwaggerBundleConfiguration.java](src/main/java/io/federecio/dropwizard/swagger/SwaggerBundleConfiguration.java)\n\nA note on Swagger 2\n-------------------\n\nHost 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.\n\n\nContributors\n------------\n\n* Federico Recio [@federecio](http://twitter.com/federecio)\n* Jochen Szostek [prefabsoft](http://prefabsoft.com)\n* Damien Raude-Morvan [drazzib](https://github.com/drazzib)\n* Marcel Stör [marcelstoer](https://github.com/marcelstoer)\n* Flemming Frandsen [dren-dk](https://github.com/dren-dk)\n* Tristan Burch [tburch](https://github.com/tburch)\n* Matt Carrier [mattcarrier](https://github.com/mattcarrier)\n* Justin Plock [jplock](https://github.com/jplock)\n* Ian Rogers [IanRogers-LShift](https://github.com/IanRogers-LShift)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmoketurner%2Fdropwizard-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmoketurner%2Fdropwizard-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmoketurner%2Fdropwizard-swagger/lists"}