{"id":15509585,"url":"https://github.com/huan/swagger-edit","last_synced_at":"2025-04-23T02:41:18.988Z","repository":{"id":91647364,"uuid":"82464251","full_name":"huan/swagger-edit","owner":"huan","description":"Swagger-Editor for local files like VIM.","archived":false,"fork":false,"pushed_at":"2017-02-20T14:21:43.000Z","size":13,"stargazers_count":14,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-12T05:03:04.266Z","etag":null,"topics":["browser","docker","editor","openapi","specification","swagger"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/zixia/swagger-edit/","language":"JavaScript","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/huan.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2017-02-19T14:20:11.000Z","updated_at":"2025-02-24T08:58:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"ab31103a-fb91-46f5-a8b5-3251c72d0961","html_url":"https://github.com/huan/swagger-edit","commit_stats":{"total_commits":8,"total_committers":1,"mean_commits":8.0,"dds":0.0,"last_synced_commit":"ebe53aadbd8fbed5e80bd4660b2ef4f6accc213b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huan%2Fswagger-edit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huan%2Fswagger-edit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huan%2Fswagger-edit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huan%2Fswagger-edit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/huan","download_url":"https://codeload.github.com/huan/swagger-edit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250360211,"owners_count":21417716,"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":["browser","docker","editor","openapi","specification","swagger"],"created_at":"2024-10-02T09:43:17.930Z","updated_at":"2025-04-23T02:41:18.978Z","avatar_url":"https://github.com/huan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# swagger-edit\nSwagger-Editor for local files like VIM.\n\n[![dockeri.co](http://dockeri.co/image/zixia/swagger-edit)](https://hub.docker.com/r/zixia/swagger-edit/)\n\n\n## The Problem\n\nThe [Swagger Editor](http://swagger.io/swagger-editor/) is great. \n\nHowever, It only open online URL. It can not open your local file directly, which is what I want to do.\n\nHow can we edit our swagger specification yaml file just like use a **VIM**?\n\n```shell\n$ swagger-edit my-api.yaml\n```\n\nThat will be cool, also very convienence.\n\n## The Solution\n\nUse [Swagger-Edit](http://hub.docker.com/r/zixia/swagger-edit) docker image!\n\nTo edit your `my-api.yaml`, just run:\n\n```shell\n$ docker run -ti --rm --volume=\"$(pwd)\":/swagger -p 8080:8080 zixia/swagger-edit my-api.yaml\n```\n\nThen open your browser and goto the URL: \u003chttp://127.0.0.1:8080/\u003e, that's it.\n\nHope you like it!\n\n## Tips\n\nFor more convenience, we can setup a function as a command(in bash):\n\n```bash\n$ function swagger-edit() {\n  docker run -ti --rm --volume=\"$(pwd)\":/swagger -p 8080:8080 zixia/swagger-edit \"$@\"\n}\n\n$ swagger-edit my-api.yaml\n```\n\nAuthor\n-----------------\nZhuohuan LI \u003czixia@zixia.net\u003e (http://linkedin.com/in/zixia)\n\n\u003ca href=\"http://stackoverflow.com/users/1123955/zixia\"\u003e\n\u003cimg src=\"http://stackoverflow.com/users/flair/1123955.png\" width=\"208\" height=\"58\" alt=\"profile for zixia at Stack Overflow, Q\u0026amp;A for professional and enthusiast programmers\" title=\"profile for zixia at Stack Overflow, Q\u0026amp;A for professional and enthusiast programmers\"\u003e\n\u003c/a\u003e\n\nCopyright \u0026 License\n-------------------\n* Code \u0026 Documentation 2017© zixia\n* Code released under the Apache 2.0 license\n* Docs released under Creative Commons\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuan%2Fswagger-edit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhuan%2Fswagger-edit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuan%2Fswagger-edit/lists"}