[{"_1":2,"_184":-5,"_185":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_163":164},"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":89,"_113":114,"_152":-5,"_153":11,"_154":21,"_155":11,"_156":-5,"_157":11,"_158":-5,"_159":160,"_161":115,"_162":-7},"canonicalUrl","https://hub.docker.com/r/coldbrewcoderss/swagger-diff/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","coldbrewcoderss","reponame","swagger-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":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2019-12-17T02:24:07.985516Z","description","Swagger API documentation change alerts via slack messages","is_private","last_updated","2020-01-10T04:20:18.527597Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",374,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","swagger-diff is a small web-service written in C# ASP.NET that exposes a webhook in order to detect Swagger API documentation changes and respond with alert messages on your slack workspace.\n\n\nFirst, you will need to create a personal slack app and create a slack webhook that will allow you to post messages to a channel in your workspace via a HTTP POST request.\nYou can create an app for your slack workspace here: https://api.slack.com/apps.\n\n\nNext, create a .env file that defines the following ENV variables. These will govern the configuration and behavior for your instance of swagger-diff:\n\n\nSWAGGER_DIFF_HOSTNAME={HOSTED_SWAGGER_DOCUMENTATION_ORIGIN/HOSTNAME}
\nSWAGGER_DIFF_PORT={SWAGGER_DOCUMENTATION_PORT} (default 80)
\nSWAGGER_DIFF_SERVICENAMES={COMMA_DELIMITED_LIST_OF_WEB_SERVICE_NAMES}
\nSWAGGER_DIFF_API_VERSION={API_VERSION_NUMBER}
\nSWAGGER_DIFF_SLACK_WEBHOOK={SLACK_APP_WEBHOOK}

\n\nEx.
\nSWAGGER_DIFF_HOSTNAME=https://my-swagger-url.com
\nSWAGGER_DIFF_PORT=443
\nSWAGGER_DIFF_SERVICENAMES=service1,service2 (<--- NO SPACES!)
\nSWAGGER_DIFF_API_VERSION=1
\nSWAGGER_DIFF_SLACK_WEBHOOK=https://hooks.slack.com/services/asdasdfasdf/asdfasdfasdf/asdfasdfasdfasdf
\n\n\nNext run the image with these ENV variables:\n\ndocker run --env-file .env -p 8000:80 coldbrewcoderss/swagger-diff:latest\n\nNow you will have a running instance of the container. With the above test config, here is the behavior:\n\n\nFirst, the initialization phase of the app runs. This will load Swagger API documentation JSON files from the following two urls:\n\n1. https://my-swagger-url.com:443/api/service1/swagger/1/swagger.json\n2. https://my-swagger-url.com:443/api/service2/swagger/1/swagger.json\n\nThese documentation JSON files are saved in memory. Next the following 2 webhooks are exposed:\n\n1. GET or POST localhost:8000/api/swaggerdiff/service1\n2. GET or POST localhost:8000/api/swaggerdiff/service2\n\nIf we send the API request GET localhost:8000/api/swaggerdiff/service2:\n- swagger-diff will fetch the Swagger API documentation JSON file from the url: https://my-swagger-url.com:443/api/service2/swagger/1/swagger.json\n- swagger-diff will compare the newly fetched file with the previously stored file and check for endpoint additions and removals. \n- If API endpoint additions or removals are detected, a slack message will be sent via your slack app and posted in your configured workspace.\n- If changes are detected, swagger-diff will save the latest version of the Swagger API documentation JSON file for the web-service \"service2\" for future comparisons.\n\nThe webhooks exposed by swagger-diff are intended to be used by your CICD pipeline. Triggering a request to the exposed webhook after each web-service deployment will alert your development team of API changes automatically, simplifying and automating team-wide communication. \n\n\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",86135399,"orgData",{"_90":91,"_92":93,"_94":95,"_96":33,"_97":98,"_99":100,"_101":102,"_103":104,"_105":106,"_107":108,"_109":110,"_111":110,"_112":21},"id","6f3275cdd3a84adc82f29754088cbc7a","uuid","6f3275cd-d3a8-4adc-82f2-9754088cbc7a","type","organization","orgname","full_name","Cold Brew Coders","location","Everywhere","company","N/A","profile_url","https://github.com/coldbrewcoders","date_joined","2019-12-04T18:09:57.744255Z","gravatar_url","https://www.gravatar.com/avatar/a858ec2820263b0b00dc86439df5f420?s=80&r=g&d=mm","gravatar_email","","badge","is_active","recentTags",[115],{"_116":44,"_117":118,"_119":120,"_90":121,"_122":123,"_50":140,"_141":118,"_142":143,"_144":56,"_57":145,"_146":147,"_148":131,"_149":140,"_150":66,"_151":21},"content_type","creator",7766738,"full_size",85009170,80047865,"images",[124],{"_125":126,"_127":128,"_129":110,"_130":131,"_132":133,"_134":135,"_136":110,"_137":-5,"_138":120,"_63":66,"_139":-5},"architecture","amd64","digest","sha256:f2e63f0f10669d3f95eaa43639ac815b9cdce2dde5e97b8b554c5576add5c2a6","features","last_pulled","2026-09-21T16:57:34.738723754Z","last_pushed","2020-01-10T04:20:18Z","os","linux","os_features","os_version","size","variant","2020-01-10T04:20:17.992439Z","last_updater","last_updater_username","ahnilica","media_type","latest","repository",8190218,"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":165,"_172":173,"_159":182,"_183":11},{"_40":166,"_42":167,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":168,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":169,"_79":11,"_80":171,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":170},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_174":64,"_175":-5,"_176":-5,"_177":178},"count","next","previous","results",[179],{"_116":44,"_117":118,"_119":120,"_90":121,"_122":180,"_50":140,"_141":118,"_142":143,"_144":56,"_57":145,"_146":147,"_148":131,"_149":140,"_150":66,"_151":21},[181],{"_125":126,"_127":128,"_129":110,"_130":131,"_132":133,"_134":135,"_136":110,"_137":-5,"_138":120,"_63":66,"_139":-5},[],"canDeleteTags","actionData","errors"]

coldbrewcoderss/swagger-diff

Tags for coldbrewcoderss/swagger-diff