{"id":24750915,"url":"https://github.com/visualbean/swaggerdiffapi","last_synced_at":"2026-04-12T04:35:52.249Z","repository":{"id":193872418,"uuid":"164020560","full_name":"VisualBean/SwaggerDiffApi","owner":"VisualBean","description":"A simple node api for diffing swagger specs","archived":false,"fork":false,"pushed_at":"2023-04-30T04:25:41.000Z","size":256,"stargazers_count":0,"open_issues_count":4,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-01-28T09:51:38.431Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/VisualBean.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-01-03T20:38:04.000Z","updated_at":"2023-03-13T13:52:15.000Z","dependencies_parsed_at":"2023-09-10T15:11:17.739Z","dependency_job_id":null,"html_url":"https://github.com/VisualBean/SwaggerDiffApi","commit_stats":null,"previous_names":["visualbean/swaggerdiffapi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VisualBean%2FSwaggerDiffApi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VisualBean%2FSwaggerDiffApi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VisualBean%2FSwaggerDiffApi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VisualBean%2FSwaggerDiffApi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VisualBean","download_url":"https://codeload.github.com/VisualBean/SwaggerDiffApi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245052619,"owners_count":20553161,"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":[],"created_at":"2025-01-28T09:51:15.580Z","updated_at":"2025-12-30T23:40:39.583Z","avatar_url":"https://github.com/VisualBean.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SwaggerDiff API\n\nA simple to use swaggerdiff api based on [SwaggerDiff](https://github.com/zallek/swagger-diff)\nTo be used for backwards compatibility checks or similar for your apis.\n\nThe Docker image is about 110MB\n\n## Getting Started\n\nThe api is located on port 80 and has one endpoint\n`/diff`\n\nthe diff endpoint takes a POST request with a simple body\n\n```\n{\n  \"old\": \"\",\n  \"new\": \"\"\n}\n```\n\nwhere old, is the old previous spec and new is the.. you guessed it.. new spec.\n\n### Example\n\n```\n{\n  \"old\": \"https://raw.githubusercontent.com/swagger-api/swagger-spec/master/examples/v2.0/json/petstore-expanded.json\",\n  \"new\": \"https://raw.githubusercontent.com/swagger-api/swagger-spec/master/examples/v2.0/json/petstore-minimal.json\"\n}\n```\n\nold and new can either be a uri to the swagger.json or the actual swagger.json.\n\nThe api response looks like the following\n\n```\n{\n  \"errors\": [],\n  \"warnings\": [],\n  \"infos\": [],\n  \"unmatchDiffs\": []\n}\n```\n\ncontaining the rules \"broken\".\nSee the [How it works](https://github.com/zallek/swagger-diff#how-it-works) in the swagger-diff docs\n### Prerequisites\n\n**NodeJS**\n\n### Installing\n\n#### Clone the repo\n\n```\ngit clone https://github.com/VisualBean/SwaggerDiffApi.git\n```\n\n#### Install the dependencies\n\n```\nnpm install\n```\n\n#### Run the app\n\n```\nnpm start\n```\n\nProfit! :tada:\n\n## Deployment\n\n### Build the docker image\n\n#### on windows\n\n```\n.\\build.ps1\n```\n\n#### Linux\n\n```\nbash build.sh\n```\n\n### Deploy\n\n```\ndocker run -p 80:80 -d swagger-diff-api\n```\nThe api is now available at http://localhost/diff\n## Built With\n\n- [Express](https://expressjs.com/) - Node Server\n- [SwaggerDiff](https://github.com/zallek/swagger-diff) - SwaggerDiffer\n- [Nodemon](https://nodemon.io/) - For hot-reload\n- [NodeJS](https://nodejs.org)\n\n## Authors\n\n- **Alex Steinhauer-Wichmann**\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvisualbean%2Fswaggerdiffapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvisualbean%2Fswaggerdiffapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvisualbean%2Fswaggerdiffapi/lists"}