{"id":19838868,"url":"https://github.com/sayi/swagger-diff","last_synced_at":"2025-04-05T12:07:30.157Z","repository":{"id":37686714,"uuid":"60241393","full_name":"Sayi/swagger-diff","owner":"Sayi","description":":ski: Compare two swagger API specifications(1.x or v2.0)","archived":false,"fork":false,"pushed_at":"2023-09-18T14:47:23.000Z","size":457,"stargazers_count":284,"open_issues_count":20,"forks_count":87,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-29T11:08:52.074Z","etag":null,"topics":["compare","diff","swagger","swagger-diff"],"latest_commit_sha":null,"homepage":"http://deepoove.com/swagger-diff/","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/Sayi.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.png","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":"2016-06-02T07:18:28.000Z","updated_at":"2025-03-27T12:32:31.000Z","dependencies_parsed_at":"2024-11-12T12:19:35.515Z","dependency_job_id":"5424af29-925a-45c5-a38c-75e4ec1c54c4","html_url":"https://github.com/Sayi/swagger-diff","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sayi%2Fswagger-diff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sayi%2Fswagger-diff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sayi%2Fswagger-diff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sayi%2Fswagger-diff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sayi","download_url":"https://codeload.github.com/Sayi/swagger-diff/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247332609,"owners_count":20921853,"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":["compare","diff","swagger","swagger-diff"],"created_at":"2024-11-12T12:19:24.115Z","updated_at":"2025-04-05T12:07:30.132Z","avatar_url":"https://github.com/Sayi.png","language":"Java","readme":"## swagger-diff\n\n![Build Status](https://travis-ci.org/Sayi/swagger-diff.svg?branch=master) ![jdk1.8+](https://img.shields.io/badge/jdk-1.8%2B-orange.svg) [![Coverage Status](https://coveralls.io/repos/github/Sayi/swagger-diff/badge.svg)](https://coveralls.io/github/Sayi/swagger-diff) [![Maven](https://maven-badges.herokuapp.com/maven-central/com.deepoove/swagger-diff/badge.svg?style=plastic)](https://maven-badges.herokuapp.com/maven-central/com.deepoove/swagger-diff)\n\nCompare two swagger API specifications(1.x or v2.0) and render the difference to html file or markdown file.\n\n## :black_large_square: Command line interface (CLI) \n\n```shell\n$ java -jar swagger-diff.jar --help\nUsage: java -jar swagger-diff.jar [options]\n  Options:\n  * -old\n      old api-doc location:Json file path or Http url\n  * -new\n      new api-doc location:Json file path or Http url\n    -v\n      swagger version:1.0 or 2.0\n      Default: 2.0\n    -output-mode\n      render mode: markdown or html\n      Default: markdown\n    --help\n\n    --version\n      swagger-diff tool version\n```\nHere is one command-line example(`-old` and `-new` is required, `-v` and `-output-mode` is optional):\n```shell\njava -jar swagger-diff.jar \\\n-old http://petstore.swagger.io/v2/swagger.json \\\n-new http://petstore.swagger.io/v2/swagger.json \\\n-v 2.0 \\\n-output-mode html \u003e diff.html\n```\nDownload the fatJar or view the changelog on the **[Release Page](https://github.com/Sayi/swagger-diff/releases),** and thanks to all contributors.\n\n## Feature\n* Supports swagger spec v1.x and v2.0.\n* Depth comparison of parameters, responses, notes, http method(GET,POST,PUT,DELETE...)\n* Supports swagger api Authorization\n* Render difference of property with Expression Language\n* html \u0026 markdown render\n* Command line interface\n\n## Maven\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.deepoove\u003c/groupId\u003e\n  \u003cartifactId\u003eswagger-diff\u003c/artifactId\u003e\n  \u003cversion\u003e1.2.2\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Gradle\n```shell\ncompile group: 'com.deepoove', name: 'swagger-diff', version: '1.2.2'\n```\n\n## Usage\nSwaggerDiff can read swagger api spec from json file or http.\n```java\nSwaggerDiff diff = SwaggerDiff.compareV2(\"petstore_v2_1.json\", \"http://petstore.swagger.io/v2/swagger.json\");\n```\n## Swagger version\nv1.x\n```java\nSwaggerDiff.compareV1(\"petstore_v1_1.json\", \"petstore_v1_2.json\");\n```\n\nv2.0\n```java\nSwaggerDiff.compareV2(\"petstore_v2_1.json\", \"petstore_v2_2.json\");\n```\n\n## Render difference\n#### HTML\n```java\nString html = new HtmlRender(\"Changelog\",\n        \"http://deepoove.com/swagger-diff/stylesheets/demo.css\")\n                .render(diff);\n\ntry {\n    FileWriter fw = new FileWriter(\"testNewApi.html\");\n    fw.write(html);\n    fw.close();\n} catch (IOException e) {\n    e.printStackTrace();\n}\n```\n![image](./changelog.png)\n\n#### Markdown\n```java\nString render = new MarkdownRender().render(diff);\ntry {\n    FileWriter fw = new FileWriter(\"testDiff.md\");\n    fw.write(render);\n    fw.close();\n} catch (IOException e) {\n    e.printStackTrace();\n}\n```\n```markdown\n### What's New\n---\n* `GET` /pet/{petId} Find pet by ID\n\n### What's Deprecated\n---\n* `POST` /pet/{petId} Updates a pet in the store with form data\n\n### What's Changed\n---\n* `PUT` /pet Update an existing pet  \n    Parameter\n\n        Add body.newFeild //a feild demo by sayi\n        Add body.category.newCatFeild\n        Delete body.category.name\n* `POST` /pet Add a new pet to the store  \n    Parameter\n\n        Add tags //add new query param demo\n        Add body.newFeild //a feild demo by sayi\n        Add body.category.newCatFeild\n        Delete body.category.name\n* `DELETE` /pet/{petId} Deletes a pet  \n    Parameter\n\n        Add newHeaderParam\n* `POST` /pet/{petId}/uploadImage uploads an image for pet  \n    Parameter\n\n        petId change into not required Notes ID of pet to update change into ID of pet to update, default false\n* `POST` /user Create user  \n    Parameter\n\n        Add body.newUserFeild //a new user feild demo\n        Delete body.phone\n* `GET` /user/login Logs user into the system  \n    Parameter\n\n        Delete password //The password for login in clear text\n* `GET` /user/{username} Get user by user name  \n    Return Type\n\n        Add newUserFeild //a new user feild demo\n        Delete phone\n* `PUT` /user/{username} Updated user  \n    Parameter\n\n        Add body.newUserFeild //a new user feild demo\n        Delete body.phone\n\n```\n\n## How it works\n![image](./swagger-diff.png)\n\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsayi%2Fswagger-diff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsayi%2Fswagger-diff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsayi%2Fswagger-diff/lists"}