[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/quen2404/openapi-diff/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","quen2404","reponame","openapi-diff","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":62,"_64":65,"_66":-5,"_67":68,"_69":70,"_71":11,"_72":33,"_73":74,"_79":21,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2018-04-18T07:49:47.475439Z","description","Utility for comparing two OpenAPI specifications.","is_private","last_updated","2019-02-28T10:33:46.530072Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",40478,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","# OpenAPI-diff \n\nCompare two OpenAPI specifications(3.x) and render the difference to html file or markdown file.\n\n[![CircleCI](https://circleci.com/gh/quen2404/openapi-diff/tree/master.svg?style=svg)](https://circleci.com/gh/quen2404/openapi-diff/tree/master)\n\n# Requirements\n`jdk1.8+`\n\n# Feature\n* Supports OpenAPi spec v3.0.\n* Depth comparison of parameters, responses, endpoint, http method(GET,POST,PUT,DELETE...)\n* Supports swagger api Authorization\n* Render difference of property with Expression Language\n* html & markdown render\n\n# Maven\n\nAvailable on [Maven Central](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.qdesrame%22%20AND%20a%3A%22openapi-diff%22)\n\n```xml\n\n com.qdesrame\n openapi-diff\n 1.2.0\n\n```\n\n# Docker\n\nAvailable on [Docker Hub](https://hub.docker.com/r/quen2404/openapi-diff/) as `quen2404/openapi-diff`.\n\n## Build the image\n\nThis is only required if you want to try new changes in the Dockerfile of this project.\n\n```bash\ndocker build -t local-openapi-diff .\n```\n\nYou can replace the local image name `local-openapi-diff` by any name of your choice.\n\n## Run an instance\n\nIn this example the `$(pwd)/src/test/resources` directory is mounted in the `/specs` directory of the container\nin readonly mode (`ro`).\n\n```bash\ndocker run -t \\\n -v $(pwd)/src/test/resources:/specs:ro \\\n quen2404/openapi-diff /specs/path_1.yaml /specs/path_2.yaml\n```\n\nThe remote name `quen2404/openapi-diff` can be replaced with `local-openapi-diff` or the name you gave to your local image.\n\n# Usage\nOpenDiff can read swagger api spec from json file or http.\n\n## Command Line\n\n```bash\n$ openapi-diff --help\nusage: openapi-diff \n --debug Print debugging information\n --error Print error information\n -h,--help print this message\n --header use given header for authorisation\n --html export diff as html in given file\n --info Print additional information\n -l,--log use given level for log (TRACE, DEBUG,\n INFO, WARN, ERROR, OFF). Default: ERROR\n --markdown export diff as markdown in given file\n -o,--output use given format (html, markdown) for\n output in file\n --off No information printed\n --query use query param for authorisation\n --state Only output diff state: no_changes,\n incompatible, compatible\n --trace be extra verbose\n --version print the version information and exit\n --warn Print warning information\n```\n\n## Direct Invocation\n\n```java\npublic class Main {\n public static final String OPENAPI_DOC1 = \"petstore_v3_1.json\";\n public static final String OPENAPI_DOC2 = \"petstore_v2_2.yaml\";\n \n public static void main(String[] args) {\n ChangedOpenApi diff = OpenApiCompare.fromLocations(OPENAPI_DOC1, OPENAPI_DOC2);\n\n //...\n }\n}\n```\n\n### Render difference\n---\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(\n \"testNewApi.html\");\n fw.write(html);\n fw.close();\n\n} catch (IOException e) {\n e.printStackTrace();\n}\n```\n\n#### Markdown\n```java\nString render = new MarkdownRender().render(diff);\ntry {\n FileWriter fw = new FileWriter(\n \"testDiff.md\");\n fw.write(render);\n fw.close();\n \n} catch (IOException e) {\n e.printStackTrace();\n}\n```\n\n### Extensions\nThis project uses Java Service Provider Inteface (SPI) so additional extensions can be added. \n\nTo build your own extension, you simply need to create a `src/main/resources/META-INF/services/com.qdesrame.openapi.diff.compare.ExtensionDiff` file with the full classname of your implementation. Your class must also implement the `com.qdesrame.openapi.diff.compare.ExtensionDiff` interface. Then, including your library with the `openapi-diff` module will cause it to be triggered automatically.\n\n# Example\n### CLI Output\n\n```text\n==========================================================================\n== API CHANGE LOG ==\n==========================================================================\n Swagger Petstore \n--------------------------------------------------------------------------\n-- What's New --\n--------------------------------------------------------------------------\n- GET /pet/{petId}\n\n--------------------------------------------------------------------------\n-- What's Deleted --\n--------------------------------------------------------------------------\n- POST /pet/{petId}\n\n--------------------------------------------------------------------------\n-- What's Deprecated --\n--------------------------------------------------------------------------\n- GET /user/logout\n\n--------------------------------------------------------------------------\n-- What's Changed --\n--------------------------------------------------------------------------\n- PUT /pet\n Request:\n - Deleted application/xml\n - Changed application/json\n Schema: Backward compatible\n- POST /pet\n Parameter:\n - Add tags in query\n Request:\n - Changed application/xml\n Schema: Backward compatible\n - Changed application/json\n Schema: Backward compatible\n- GET /pet/findByStatus\n Parameter:\n - Deprecated status in query\n Return Type:\n - Changed 200 OK\n Media types:\n - Changed application/xml\n Schema: Broken compatibility\n - Changed application/json\n Schema: Broken compatibility\n- GET /pet/findByTags\n Return Type:\n - Changed 200 OK\n Media types:\n - Changed application/xml\n Schema: Broken compatibility\n - Changed application/json\n Schema: Broken compatibility\n- DELETE /pet/{petId}\n Parameter:\n - Add newHeaderParam in header\n- POST /pet/{petId}/uploadImage\n Parameter:\n - Changed petId in path\n- POST /user\n Request:\n - Changed application/json\n Schema: Backward compatible\n- POST /user/createWithArray\n Request:\n - Changed application/json\n Schema: Backward compatible\n- POST /user/createWithList\n Request:\n - Changed application/json\n Schema: Backward compatible\n- GET /user/login\n Parameter:\n - Delete password in query\n- GET /user/logout\n- GET /user/{username}\n Return Type:\n - Changed 200 OK\n Media types:\n - Changed application/xml\n Schema: Broken compatibility\n - Changed application/json\n Schema: Broken compatibility\n- PUT /user/{username}\n Request:\n - Changed application/json\n Schema: Backward compatible\n--------------------------------------------------------------------------\n-- Result --\n--------------------------------------------------------------------------\n API changes broke backward compatibility \n--------------------------------------------------------------------------\n```\n\n### Markdown\n```markdown\n### What's New\n---\n* `GET` /pet/{petId} Find pet by ID\n\n### What's Deleted\n---\n* `POST` /pet/{petId} Updates a pet in the store with form data\n\n### What's Deprecated\n---\n* `GET` /user/logout Logs out current logged in user session\n\n### What's Changed\n---\n* `PUT` /pet Update an existing pet \n Request\n\n Deleted request body : [application/xml]\n Changed response : [application/json]\n* `POST` /pet Add a new pet to the store \n Parameter\n\n Add tags //add new query param demo\n Request\n\n Changed response : [application/xml]\n Changed response : [application/json]\n* `GET` /pet/findByStatus Finds Pets by status \n Parameter\n\n Return Type\n\n Changed response : [200] //successful operation\n* `GET` /pet/findByTags Finds Pets by tags \n Return Type\n\n Changed response : [200] //successful operation\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 Notes ID of pet to update change into ID of pet to update, default false\n* `POST` /user Create user \n Request\n\n Changed response : [application/json]\n* `POST` /user/createWithArray Creates list of users with given input array \n Request\n\n Changed response : [application/json]\n* `POST` /user/createWithList Creates list of users with given input array \n Request\n\n Changed response : [application/json]\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/logout Logs out current logged in user session \n* `PUT` /user/{username} Updated user \n Request\n\n Changed response : [application/json]\n* `GET` /user/{username} Get user by user name \n Return Type\n\n Changed response : [200] //successful operation\n```\n\n# License\nopenapi-diff is released under the Apache License 2.0.\n\n# Thanks\n* Adarsh Sharma / [adarshsharma](https://github.com/adarshsharma)\n\n\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",524684239,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":65,"_128":21},"content_type","creator",394921,"full_size",63826846,"id",25822747,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":65,"_117":-5},"architecture","amd64","digest","sha256:be05f6350b649e38473a5fdde50282ad3b4d56ae98336193e93530cb242ff91a","features","","last_pulled","2026-10-02T20:27:53.634782269Z","last_pushed","2019-02-28T10:33:47Z","os","linux","os_features","os_version","size","variant","2019-02-28T10:33:46.193364Z","last_updater","last_updater_username","media_type","latest","repository",5402207,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":62,"_64":65,"_66":-5,"_67":68,"_69":70,"_71":11,"_72":33,"_73":146,"_79":21,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":62,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":65,"_128":21},[158],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":65,"_117":-5},[],"canDeleteTags","actionData","errors"]

quen2404/openapi-diff

Tags for quen2404/openapi-diff