{"id":13505415,"url":"https://github.com/moon0326/swagger-ui-watcher","last_synced_at":"2025-12-27T07:31:51.998Z","repository":{"id":39422713,"uuid":"98866334","full_name":"moon0326/swagger-ui-watcher","owner":"moon0326","description":"Automatically refreshes Swagger UI on Swagger file changes","archived":false,"fork":false,"pushed_at":"2024-03-25T07:03:29.000Z","size":3176,"stargazers_count":168,"open_issues_count":6,"forks_count":36,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-24T16:24:19.741Z","etag":null,"topics":["multifile-swagger","swagger","watch"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/moon0326.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2017-07-31T08:28:40.000Z","updated_at":"2024-04-10T21:31:28.000Z","dependencies_parsed_at":"2024-03-22T20:46:58.566Z","dependency_job_id":null,"html_url":"https://github.com/moon0326/swagger-ui-watcher","commit_stats":{"total_commits":112,"total_committers":15,"mean_commits":7.466666666666667,"dds":0.6785714285714286,"last_synced_commit":"6ffe90f52959625e18151eda506bc53e139559f0"},"previous_names":["moon0326/swagger-watcher"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moon0326%2Fswagger-ui-watcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moon0326%2Fswagger-ui-watcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moon0326%2Fswagger-ui-watcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moon0326%2Fswagger-ui-watcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/moon0326","download_url":"https://codeload.github.com/moon0326/swagger-ui-watcher/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246262490,"owners_count":20749170,"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":["multifile-swagger","swagger","watch"],"created_at":"2024-08-01T00:01:06.069Z","updated_at":"2025-12-27T07:31:51.991Z","avatar_url":"https://github.com/moon0326.png","language":"JavaScript","funding_links":[],"categories":["Documentation"],"sub_categories":["Swagger"],"readme":"# Swagger UI Watcher\n\nSwagger UI Watcher detects changes in your local Swagger files and reload Swagger UI in your browser to give you fluid workflow. It is primarily developed to work with multiple Swagger files using \\$ref.\n\n## Why?\n\n- Using online Swagger Editor is annoying. You have to copy and paste your Swagger files back and forth.\n- Relative and local system \\$ref do not work with online Swagger Editor v3\n- Manually creating bundle from multiple Swagger files after each update is impractical and tiresome.\n- Using my editor/ide of choice is awesome.\n\n## Installation\n\n| Version | Swagger Version |\n| ------- | --------------- |\n| 1.0.10 | 2 |\n| \u003e=2.0 | 3 |\n\n```\nnpm install swagger-ui-watcher -g\n```\n\n## Usage\n\nFor watching the changes in target directory, following command is used\n\n```\nswagger-ui-watcher ./main-swagger-file.json\n```\n\n### Additional Options\n\n| Command line argument | Description |\n| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| -p --port \u003cport\u003e | Default is 8000 |\n| -h --host \u003cHostname/IP\u003e | Defaults to 127.0.0.1 |\n| --no-open | Do not open the view page in the default browser |\n| -c --config \u003cJSON_file\u003e | JSON file containing any of the [Swagger UI options](https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md). Example: `{\"withCredentials\": true}` |\n| -b --bundle \u003cbundleLocation\u003e | Create bundle at the specified location |\n| -i --ignore \u003cmatches\u003e | File or path omitted from watching. Supports globbing |\n\nFor creating the bundled file, provide the optional argument `bundle`\n\n```\nswagger-ui-watcher ./main-swagger-file.json --bundle=./bundled.json\n```\n\nClick the image to see it in action\n\n[![Alt text](http://i.imgur.com/UQMAn4U.png)](https://www.youtube.com/embed/ejBS75q3ouo?autoplay=1)\n\n## Do What You Want to Public License\n\n```\n DO WHAT YOU WANT TO PUBLIC LICENSE\n Version 3, January 2012\n\n Copyright (C) 2012 Ryan Thompson\n\n Everyone is permitted to copy and distribute verbatim or modified\n copies of this license document, and changing it is allowed as long\n as the name is changed.\n\n DO WHAT YOU WANT TO PUBLIC LICENSE\n TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION\n\n 0. You just DO WHAT YOU WANT TO.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoon0326%2Fswagger-ui-watcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoon0326%2Fswagger-ui-watcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoon0326%2Fswagger-ui-watcher/lists"}