{"id":22059217,"url":"https://github.com/pegasystems/api2swagger","last_synced_at":"2025-05-12T19:45:44.304Z","repository":{"id":89402390,"uuid":"89421552","full_name":"pegasystems/api2swagger","owner":"pegasystems","description":"Auto generation of Swagger JSON by invoking REST API","archived":false,"fork":false,"pushed_at":"2024-03-29T17:51:42.000Z","size":142,"stargazers_count":13,"open_issues_count":5,"forks_count":4,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-01T02:49:48.817Z","etag":null,"topics":["swagger","swagger-documentation","swagger-generator","swagger-json"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pegasystems.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-26T01:00:27.000Z","updated_at":"2023-10-27T23:08:34.000Z","dependencies_parsed_at":"2024-03-29T18:58:06.627Z","dependency_job_id":null,"html_url":"https://github.com/pegasystems/api2swagger","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pegasystems%2Fapi2swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pegasystems%2Fapi2swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pegasystems%2Fapi2swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pegasystems%2Fapi2swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pegasystems","download_url":"https://codeload.github.com/pegasystems/api2swagger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253809893,"owners_count":21967819,"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":["swagger","swagger-documentation","swagger-generator","swagger-json"],"created_at":"2024-11-30T17:27:34.577Z","updated_at":"2025-05-12T19:45:44.277Z","avatar_url":"https://github.com/pegasystems.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/pegasystems/api2swagger.svg?branch=master)](https://travis-ci.org/pegasystems/api2swagger)\n[![codecov](https://codecov.io/gh/pegasystems/api2swagger/branch/master/graph/badge.svg)](https://codecov.io/gh/pegasystems/api2swagger)\n\n# API2Swagger\n\n\u003ca href=\"https://www.pega.com\"\u003e\n\u003cimg src=\"https://www.pega.com/profiles/pegasystems/themes/custom/pegas/pegakit/public/images/logos/pega-logo.svg\" width=\"200\" alt=\"Pegasystems\"/\u003e\n\u003c/a\u003e\n\nManual generation and maintenance of Swagger JSON for REST services can be painful because you have to provide too many details about a REST service. To avoid this manual work we have developed API2Swagger tool to generate Swagger JSON automatically by invoking REST service(s).\n\n# Features!\n\n  - Swagger JSON generation using builders\n  - Swagger JSON generation using command line utility\n  - JSON schema generation from JSON response data\n  - Capability of updating existing Swagger JSON document with new API\n  - Capability of modifying existing Swagger JSON with API related modifications - which includes adding new request parameters, response changes\n  - Capability of recognizing 'FILE' downloads via REST API because Swagger JSON document has special way treating for FILE downloads\n\n### Installation\n\nTo build the project including standalone jar\n\n```bat\n./gradlew clean buildall\n```\n\nBuilt library can be found under `\u003croot-project\u003e/build/libs`.\n\n- `api2swagger-1.0.jar` is a binary that can be used in other applications as a library\n- `api2swagger-all-1.0.jar` is a binary to be used as a standalone application\n\n### Command Line Arguments\n\nVarious command line options are:\n\n| Argument | Human Readable Form |Description |\n| ---------- | ---------- | ---------- |\n| -e | --endpoint | specify endpoint URL, this URL will be invoked and response will be generated. |\n| -o | \\-\\-output | output file to which Swagger JSON will be written |\n| -m | \\-\\-method | specify HTTP verb - GET, POST on which endpoint URL will be invoked |\n| -h | \\-\\-header |specify any request headers that should be sent when endpoint URL is invoked |\n| -p | \\-\\-param | specify request param in key value params e.g: param=value, you can specify multiple \\-p arguments |\n| -pp | \\-\\-pathparam | specify path parameter values part of endpoint URL, path parameters should  be specified in endpoint as \"{pathParameterName}\" and its value specified using this argument. You can specify multiple path parameters. please refer examples section for more details. |\n| -a | \\-\\-authentication |Acts as a boolean command line arguments specifying whether authentication is required for invoking endpoint URL |\n| -username | \\-\\-username | Username for authentication|\n| -password | \\-\\-password | Password for authentication |\n| -host | \\-\\-host | Hostname value will be populated in Swagger JSON's 'host' attribute |\n| -apipath | \\-\\-apipath | Base Path for Swagger document |\n| -apiname | \\-\\-apiname | Unique API name for a given endpoint URL |\n| -apidescription | \\-\\-apidescription | API Description for a given endpoint URL |\n| -apisummary | \\-\\-apisummary | Summary for given endpoint URL |\n| -tag | \\-\\-apiTag | Tag name for given endpoint URL. You can provide multiple tag names for the endpoint |\n| -basepath | \\-\\-basepath | Base Path for Swagger JSON's 'basepath' attribute, Swagger API path is calculated from base path |\n| -help | \\-\\-help | Display help |\n\n### CLI Examples\n\nGET API without any parameters and authentication:\n\n```sh\n\u003cJAVA_HOME\u003e/bin/java\" -jar %JAR% -e \"http://httpbin.org/ip\" -o \"SWAGGER-DOC-FILE-PATH\" -m \"GET\" -apiname \"UniqueApiName\" -tag \"GetIPAddress\" -apiSummary \"API to fetch IP Address\" -apidescription \"Fetch IP address in origin attribute\"\n```\nGET API with authentication using -a, --username and --password:\n\n```sh\n\u003cJAVA_HOME\u003e/bin/java\" -jar %JAR% -e \"http://httpbin.org/ip\" -o \"SWAGGER-DOC-FILE-PATH\" -m \"GET\" -a --username \"someusername\" --password \"somePassword\" -apiname \"UniqueApiName\" -tag \"GetIPAddress\" -apisummary \"API to fetch IP Address\" -apidescription \"Fetch IP address in origin attribute\"\n```\nGET API with query parameters using -p argument:\n\n```sh\n\u003cJAVA_HOME\u003e/bin/java\" -jar %JAR% -e \"http://httpbin.org/ip\" -o \"SWAGGER-DOC-FILE-PATH\" -m \"GET\" -a --username \"someusername\" --password \"somePassword\" -p \"param1=value1\" -p \"param2=value2\" -apiname \"UniqueApiName\" -tag \"GetIPAddress\" -apisummary \"API to fetch IP Address\" -apidescription \"Fetch IP address in origin attribute\"\n```\n\nGET API with path parameters using -pp argument:\n\n```sh\n\u003cJAVA_HOME\u003e/bin/java\" -jar %JAR% -e \"http://httpbin.org/ip/{pathparam1}/{pathparam2}\" -o \"SWAGGER-DOC-FILE-PATH\" -m \"GET\" -a --username \"someusername\" --password \"somePassword\" -pp \"pathparam1=value1\" -pp \"pathparam2=value2\" -apiname \"UniqueApiName\" -tag \"GetIPAddress\" -apisummary \"API to fetch IP Address\" -apidescription \"Fetch IP address in origin attribute\"\n```\n\nGET API with path parameters using -pp argument and query parameters using -p:\n\n```sh\n\u003cJAVA_HOME\u003e/bin/java\" -jar %JAR% -e \"http://httpbin.org/ip/{pathparam1}/{pathparam2}\" -o \"SWAGGER-DOC-FILE-PATH\" -m \"GET\" -a --username \"someusername\" --password \"somePassword\" -pp \"pathparam1=value1\" -pp \"pathparam2=value2\" -p \"queryparam=value\" -apiname \"UniqueApiName\" -tag \"GetIPAddress\" -apisummary \"API to fetch IP Address\" -apidescription \"Fetch IP address in origin attribute\"\n```\n\nPOST API with path parameters using -pp argument and query parameters using -p:\n\n```sh\n\u003cJAVA_HOME\u003e/bin/java\" -jar %JAR% -e \"http://httpbin.org/ip/{pathparam1}/{pathparam2}\" -o \"SWAGGER-DOC-FILE-PATH\" -m \"POST\" -a --username \"someusername\" --password \"somePassword\" -pp \"pathparam1=value1\" -pp \"pathparam2=value2\" -p \"queryparam=value\" -apiname \"UniqueApiName\" -tag \"GetIPAddress\" -apisummary \"API to fetch IP Address\" -apidescription \"Fetch IP address in origin attribute\"\n```\n\nDELETE API with parameters:\n\n```sh\n\u003cJAVA_HOME\u003e/bin/java\" -jar %JAR% -e \"http://httpbin.org/ip/{pathparam1}/{pathparam2}\" -o \"SWAGGER-DOC-FILE-PATH\" -m \"DELETE\" -a --username \"someusername\" --password \"somePassword\" -pp \"pathparam1=value1\" -pp \"pathparam2=value2\" -p \"queryparam=value\" -apiname \"UniqueApiName\" -tag \"GetIPAddress\" -apisummary \"API to fetch IP Address\" -apidescription \"Fetch IP address in origin attribute\"\n```\n\n### Swagger Model generation using APIs\n\nYou can use `SwaggerGenerator` class for generating Swagger JSON, just pass `SwaggerGeneratorInput` to generator class..voila it will generate `Swagger` model for you!\n\n### Example for generating Swagger Model using API\n\n```java\nSwaggerGeneratorInput userInput = new SwaggerGeneratorInput.Builder()\n                                 .endpoint(endpoint)\n\t\t\t\t\t\t\t\t .method(method)\n\t\t\t\t\t\t\t\t .pathParams(pathParamMap)\n\t\t\t\t\t\t\t\t .parameters(paramMap)\n\t\t\t\t\t\t\t\t .headers(headerMap)\n\t\t\t\t\t\t\t\t .swaggerJSONFilePath(outputFilePath)\n\t\t\t\t\t\t\t\t .authentication(isAuthenticationNeeded)\n\t\t\t\t\t\t\t\t .username(username)\n\t\t\t\t\t\t\t\t .password(password)\n\t\t\t\t\t\t\t\t .host(host)\n\t\t\t\t\t\t\t\t .basePath(basePath)\n\t\t\t\t\t\t\t\t .apiName(apiName)\n\t\t\t\t\t\t\t\t .apiDescription(apiDescription)\n\t\t\t\t\t\t\t\t .apiSummary(apiSummary)\n\t\t\t\t\t\t\t\t .apiTags(apiTags)\n\t\t\t\t\t\t\t\t .build();\nSwaggerGenerator main = new SwaggerGenerator(userInput);\nOptional\u003cSwagger\u003e outputSwagger = main.buildSwaggerJson();\nif(outputSwagger.isPresent()){\n\t\t//then do something...\n}\n```\n\n### Development\n\nWant to contribute? Great!\nOpen an issue or email me providing your feedback or open a pull request.\n\n### Todos\n\n - Consider JSON request data\n - Consider to emit response headers in Swagger JSON document\n - Consider to generate Swagger document in XML format\n - Fix bugs\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpegasystems%2Fapi2swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpegasystems%2Fapi2swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpegasystems%2Fapi2swagger/lists"}