{"id":21434127,"url":"https://github.com/bernardo-mg/java-servlet-swagger-v3-example","last_synced_at":"2025-08-20T18:59:44.390Z","repository":{"id":62199215,"uuid":"558721143","full_name":"Bernardo-MG/java-servlet-swagger-v3-example","owner":"Bernardo-MG","description":"Example documenting a java Servlet with Swagger for OpenApi v3","archived":false,"fork":false,"pushed_at":"2023-03-28T08:25:25.000Z","size":57,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-01T22:57:05.588Z","etag":null,"topics":["example","java-servlet","swagger"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Bernardo-MG.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-28T06:29:28.000Z","updated_at":"2022-10-28T07:33:53.000Z","dependencies_parsed_at":"2025-01-23T09:10:25.847Z","dependency_job_id":"be3c19eb-e233-48cb-a2d7-4376eeeb9680","html_url":"https://github.com/Bernardo-MG/java-servlet-swagger-v3-example","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Bernardo-MG/java-servlet-swagger-v3-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bernardo-MG%2Fjava-servlet-swagger-v3-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bernardo-MG%2Fjava-servlet-swagger-v3-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bernardo-MG%2Fjava-servlet-swagger-v3-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bernardo-MG%2Fjava-servlet-swagger-v3-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bernardo-MG","download_url":"https://codeload.github.com/Bernardo-MG/java-servlet-swagger-v3-example/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bernardo-MG%2Fjava-servlet-swagger-v3-example/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265453652,"owners_count":23768177,"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":["example","java-servlet","swagger"],"created_at":"2024-11-22T23:33:27.468Z","updated_at":"2025-07-15T19:16:31.659Z","avatar_url":"https://github.com/Bernardo-MG.png","language":"Java","readme":"# Java Servlet with Swagger for OpenApi v3 Example\n\nExample setting up Swagger for OpenApi 3 in a Servlet. This is an extension of the [Java Servlet Example](https://github.com/Bernardo-MG/java-servlet-example).\n\n[![Release docs](https://img.shields.io/badge/docs-release-blue.svg)][site-release]\n[![Development docs](https://img.shields.io/badge/docs-develop-blue.svg)][site-develop]\n\n[![Release javadocs](https://img.shields.io/badge/javadocs-release-blue.svg)][javadoc-release]\n[![Development javadocs](https://img.shields.io/badge/javadocs-develop-blue.svg)][javadoc-develop]\n\n## Features\n\n- Java servlet\n- Swagger for OpenApi v3 servlet documentation\n\n## Documentation\n\nDocumentation is always generated for the latest release, kept in the 'master' branch:\n\n- The [latest release documentation page][site-release].\n- The [latest release Javadoc site][javadoc-release].\n\nDocumentation is also generated from the latest snapshot, taken from the 'develop' branch:\n\n- The [the latest snapshot documentation page][site-develop].\n- The [latest snapshot Javadoc site][javadoc-develop].\n\n### Building the docs\n\nThe documentation site is actually a Maven site, and its sources are included in the project. If required it can be generated by using the following Maven command:\n\n```\nmvn verify site\n```\n\nThe verify phase is required, otherwise some of the reports won't be generated.\n\n## Usage\n\nBuild the war and deploy it in a servlet container, such as Tomcat.\n\nIf deployed locally then the project will be accessible at the URL:\n\n```\nhttp://localhost:8080/java-servlet-swagger-v3-example/hello?name=me\n```\n\nThe API docs will be available at:\n\n```\nhttp://localhost:8080/java-servlet-swagger-v3-example/api-docs/swagger.json\n```\n\n### Docker image\n\nTo ease deploying the project, Docker files are included:\n\n```\ndocker-compose -f docker/docker-compose.yml --project-name java-servlet-swagger-v3-example up\n```\n\n## Collaborate\n\nAny kind of help with the project will be well received, and there are two main ways to give such help:\n\n- Reporting errors and asking for extensions through the issues management\n- or forking the repository and extending the project\n\n### Issues management\n\nIssues are managed at the GitHub [project issues tracker][issues], where any Github user may report bugs or ask for new features.\n\n### Getting the code\n\nIf you wish to fork or modify the code, visit the [GitHub project page][scm], where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.\n\n## License\n\nThe project has been released under the [MIT License][license].\n\n[issues]: https://github.com/bernardo-mg/java-servlet-swagger-v3-example/issues\n[javadoc-develop]: https://docs.bernardomg.com/development/maven/java-servlet-swagger-v3-example/apidocs\n[javadoc-release]: https://docs.bernardomg.com/maven/java-servlet-swagger-v3-example/apidocs\n[license]: https://www.opensource.org/licenses/mit-license.php\n[scm]: https://github.com/bernardo-mg/java-servlet-swagger-v3-example\n[site-develop]: https://docs.bernardomg.com/development/maven/java-servlet-swagger-v3-example\n[site-release]: https://docs.bernardomg.com/maven/java-servlet-swagger-v3-example\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbernardo-mg%2Fjava-servlet-swagger-v3-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbernardo-mg%2Fjava-servlet-swagger-v3-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbernardo-mg%2Fjava-servlet-swagger-v3-example/lists"}