{"id":23188408,"url":"https://github.com/xavierchow/vim-swagger-preview","last_synced_at":"2025-08-18T17:34:09.438Z","repository":{"id":145891023,"uuid":"150367884","full_name":"xavierchow/vim-swagger-preview","owner":"xavierchow","description":"A Vim plugin for previewing swagger/openAPI spec in Chrome with swagger-ui.","archived":false,"fork":false,"pushed_at":"2024-04-04T09:07:04.000Z","size":18,"stargazers_count":28,"open_issues_count":1,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-14T22:20:45.683Z","etag":null,"topics":["chrome","openapi","preview","swagger","swagger-ui","vim"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/xavierchow.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":"2018-09-26T04:18:47.000Z","updated_at":"2024-04-12T16:53:33.000Z","dependencies_parsed_at":"2023-07-20T23:45:32.240Z","dependency_job_id":null,"html_url":"https://github.com/xavierchow/vim-swagger-preview","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xavierchow%2Fvim-swagger-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xavierchow%2Fvim-swagger-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xavierchow%2Fvim-swagger-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xavierchow%2Fvim-swagger-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xavierchow","download_url":"https://codeload.github.com/xavierchow/vim-swagger-preview/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230260644,"owners_count":18198591,"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":["chrome","openapi","preview","swagger","swagger-ui","vim"],"created_at":"2024-12-18T11:14:37.303Z","updated_at":"2024-12-18T11:14:37.730Z","avatar_url":"https://github.com/xavierchow.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"Vim Swagger Preview\n====================\n\n- [Intro](#intro)\n- [Installation](#installation)\n- [Usage](#usage)\n- [License](#licnese)\n\nIntro\n-----\n[Swagger Editor](https://swagger.io/tools/swagger-editor/) is fancy, but my favorite editor is vim, and all my code is in vim,\nI don't like to copy \u0026 paste the yaml between the swagger-editor and vim.\nThat's why I built this plugin; you can edit your yaml OpenAPI spec in vim and preview the result in Chrome.\n\nInstallation\n------------\n### Prerequisite\n* web browser\n* docker\n* make sure port `8017` is availabe to listen on, of course you can change it [here](https://github.com/xavierchow/vim-swagger-preview/blob/master/script.sh#L37).\n\n### Plugin\n\n* With [Pathogen](https://github.com/tpope/vim-pathogen): Place `vim-swagger-preview/` in `.vim/bundle/`.\n* With [Vundle](https://github.com/VundleVim/Vundle.vim):\n    * Add `Plugin 'xavierchow/vim-swagger-preview'` to your `.vimrc`.\n    * Launch `vim` and run `:PluginInstall`\n* With [vim-plug](https://github.com/junegunn/vim-plug):\n    * Setup with [vim-plug guide](https://github.com/junegunn/vim-plug#usage)\n    * Add `Plug 'xavierchow/vim-swagger-preview'` to your `.vimrc`.\n\nUsage\n-----\n\n\u003cimg src=\"https://raw.githubusercontent.com/xavierchow/asset/master/vim-swagger-preview/screenshot.gif\" height=\"450\"\u003e\n\n### File extension\nThis plugin only applies to yaml file with the OpenAPI spec.\n\n### Keymap for preview\nThe default keymap is `\u003cleader\u003ee`, it brings up a browser window and shows the swagger-ui.\nYou can also define your keymap in vimrc.\n```\nnmap \u003cunique\u003e \u003cleader\u003ee \u003cPlug\u003eGenerateDiagram \n```\n*Notes: Why I named it as `GenerateDiagram` is that I'd like to reuse the same mapping as [vim-sequence-diagram](https://github.com/xavierchow/vim-sequence-diagram).*\n\nLicense\n-----------------\n\nMIT\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxavierchow%2Fvim-swagger-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxavierchow%2Fvim-swagger-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxavierchow%2Fvim-swagger-preview/lists"}