{"id":14986723,"url":"https://github.com/agliznetsov/swagger-tools","last_synced_at":"2026-02-14T04:11:51.292Z","repository":{"id":54169735,"uuid":"135715852","full_name":"agliznetsov/swagger-tools","owner":"agliznetsov","description":"Code generator to produce java client and server mappings from Swagger / OpenAPI REST API definition.","archived":false,"fork":false,"pushed_at":"2024-05-25T11:00:48.000Z","size":380,"stargazers_count":1,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-20T05:30:53.777Z","etag":null,"topics":["code-generation","java","maven-plugin","oas","open-api","open-api-v3","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/agliznetsov.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":"2018-06-01T12:37:24.000Z","updated_at":"2024-05-25T11:00:52.000Z","dependencies_parsed_at":"2023-09-24T07:15:38.686Z","dependency_job_id":"db34bd23-0ac2-4a5b-acda-536954aa1993","html_url":"https://github.com/agliznetsov/swagger-tools","commit_stats":{"total_commits":118,"total_committers":5,"mean_commits":23.6,"dds":0.5508474576271186,"last_synced_commit":"c27d9b89c0af2d8834d394dfc5ecb56e2da4334e"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/agliznetsov/swagger-tools","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agliznetsov%2Fswagger-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agliznetsov%2Fswagger-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agliznetsov%2Fswagger-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agliznetsov%2Fswagger-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agliznetsov","download_url":"https://codeload.github.com/agliznetsov/swagger-tools/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agliznetsov%2Fswagger-tools/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262678763,"owners_count":23347418,"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":["code-generation","java","maven-plugin","oas","open-api","open-api-v3","swagger"],"created_at":"2024-09-24T14:13:25.166Z","updated_at":"2026-02-03T00:40:37.620Z","avatar_url":"https://github.com/agliznetsov.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# swagger-tools\n\n[![Build Status](https://travis-ci.org/agliznetsov/swagger-tools.svg?branch=master)](https://travis-ci.org/agliznetsov/swagger-tools)\n[![Download CLI](https://img.shields.io/maven-central/v/com.github.agliznetsov.swagger-tools/swagger-tools-cli.svg)](https://repo1.maven.org/maven2/com/github/agliznetsov/swagger-tools/swagger-tools-cli)\n\n## Overview\n\nThis project provides a set of tools to generate java code from API definition.\n\n### Source\n\n- Swagger 2.0 or OpenAPI 3.0 API definition in json/yaml format \n- Extensions\n    - **x-ignore** to exclude operations from the code generation process  \n    - **x-ignore-server** to exclude operations from the server code generation process  \n    - **x-ignore-server-client** to exclude operations from the client code generation process  \n    - **x-name** to specify OpenAPI 3 requestBody parameter name\n    - **x-base-path** to specify OpenAPI 3 API base path\n    - **x-response-entity** to make Client/Server return Spring ResponseEntity object\n    - **x-model-package** to specify package name for the model classes\n\n### Targets\n\n- Model classes. Supported dialects:\n    - Jackson2\n- Java client SDK, can be used for unit testing or to create java client applications. Supported dialects:\n    -  Spring RestTemplate\n    -  Spring WebClient\n    -  Apache HttpClient\n- Server API interfaces with HTTP mapping annotations. Supported dialects:\n    - Spring WebMVC\n    - Spring Webflux\n    - JAX-RS\n\n### Run from command line  \n\nTo get list of arguments:\n\n`java -jar swagger-tools-cli.jar`\n\nTo generate models and client code:\n\n```sh\njava -jar swagger-tools-cli.jar \\\n--source.location=swagger.yaml \\\n--target.model.location=./generated \\\n--target.model.model-package=com.example.model \\\n--target.client.location=./generated \\\n--target.client.model-package=com.example.model \\\n--target.client.client-package=com.example.client \\\n```\n\n### Run from maven\n\n```xml\n\u003cbuild\u003e\n    \u003cplugins\u003e\n        \u003cplugin\u003e\n            \u003cgroupId\u003ecom.github.agliznetsov.swagger-tools\u003c/groupId\u003e\n            \u003cartifactId\u003eswagger-tools-maven-plugin\u003c/artifactId\u003e\n            \u003cversion\u003e0.2.0\u003c/version\u003e\n            \u003cexecutions\u003e\n                \u003cexecution\u003e\n                    \u003cid\u003epetstore\u003c/id\u003e\n                    \u003cgoals\u003e\n                        \u003cgoal\u003egenerate\u003c/goal\u003e\n                    \u003c/goals\u003e\n                    \u003cconfiguration\u003e\n                        \u003csources\u003e\n                            \u003cparam\u003e${project.basedir}/src/main/resources/petstore.yaml\u003c/param\u003e\n                        \u003c/sources\u003e\n                        \u003coptions\u003e\n                            \u003ctarget.model.location\u003e${project.build.directory}/generated-sources/swagger\u003c/target.model.location\u003e\n                            \u003ctarget.model.model-package\u003eorg.swaggertools.demo.model\u003c/target.model.model-package\u003e\n\n                            \u003ctarget.client.location\u003e${project.build.directory}/generated-sources/swagger\u003c/target.client.location\u003e\n                            \u003ctarget.client.model-package\u003eorg.swaggertools.demo.model\u003c/target.client.model-package\u003e\n                            \u003ctarget.client.client-package\u003eorg.swaggertools.demo.client\u003c/target.client.client-package\u003e\n                        \u003c/options\u003e\n                    \u003c/configuration\u003e\n                \u003c/execution\u003e\n            \u003c/executions\u003e\n        \u003c/plugin\u003e\n    \u003c/plugins\u003e\n\u003c/build\u003e\n```\n\n#### Plugin configuration parameters:\n- **skip**: Skip code generation\n- **help**: Print the list of options\n- **options**: Key/Value map of arguments for the code generator. Same as for the commandline version. \n\nCheck also a complete sample application: [demo-webmvc](demo/demo-webmvc)\n\n### Run from gradle\n\nThere is no specific gradle plugin yet, but you can run code generator from gradle using command line version:\n\n```groovy\nconfigurations {\n   swagger\n}\n \ndependencies {\n   swagger 'com.github.agliznetsov.swagger-tools:swagger-tools-cli:0.8.3'\n}\n \ntask \"swagger-generate\"(type: JavaExec) {\n   classpath = configurations.swagger\n   main = 'org.swaggertools.cli.Generator'\n   args = [\n         \"--source.location\", \"src/main/resources/swagger.yaml\",\n         \"--target.model.location\", \"src/main/java\",\n         \"--target.model.model-package\", \"com.example.model\",\n   ]\n}\n```\n\n### Extensions\n\nAdditional targets can be added via java [ServiceLoader](https://docs.oracle.com/javase/tutorial/ext/basics/spi.html):\n\n- Implement [Target](swagger-tools-core/src/main/java/org/swaggertools/core/run/Target.java) interface\n- List it in the META-INF/services\n- Add your jar file to the classpath of the CLI or maven plugin\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagliznetsov%2Fswagger-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagliznetsov%2Fswagger-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagliznetsov%2Fswagger-tools/lists"}