Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asyncapi/vs-asyncapi-preview
VSCode AsyncAPI Preview Extension
https://github.com/asyncapi/vs-asyncapi-preview
get-global-node-release-workflows get-global-releaserc nodejs
Last synced: 2 months ago
JSON representation
VSCode AsyncAPI Preview Extension
- Host: GitHub
- URL: https://github.com/asyncapi/vs-asyncapi-preview
- Owner: asyncapi
- License: apache-2.0
- Created: 2020-09-16T10:48:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T04:10:28.000Z (4 months ago)
- Last Synced: 2024-10-29T22:38:04.784Z (4 months ago)
- Topics: get-global-node-release-workflows, get-global-releaserc, nodejs
- Language: TypeScript
- Homepage:
- Size: 3.1 MB
- Stars: 42
- Watchers: 7
- Forks: 36
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://marketplace.visualstudio.com/items?itemName=asyncapi.asyncapi-preview) [](https://marketplace.visualstudio.com/items?itemName=asyncapi.asyncapi-preview.svg)
# AsyncAPI Preview
Preview AsyncAPI documents inside VSCode.
AsyncAPI Preview was simplified and reworked from scratch to use the latest [@asyncapi/asyncapi-react](https://github.com/asyncapi/asyncapi-react/tree/next), removing old dependencies on Express, socket.io and js-yaml with better startup performance and bundle size.
You can open AsyncAPI Preview from the editor title/context menu. (If you don't see that button, you can use `shift+command+P` to open command palette and select `Preview AsyncAPI`.)

## Automatic hot-reloading
Automatic hot-reloading on editor save, but currently, it doesn't reload when saving referenced external files.
## Content Assistance
### Available snippets:
Open an empty or otherwise yaml file and start typing one of the following prefixes, you may need to press `Ctrl+space` to trigger autocompletion in some cases:
- `add asyncapi skeleton`: Adds an asyncapi skeleton for jump starting your API editing.
- `add asyncapi subscribe to async request`: Inserts a new subscribe operation, for listening to incoming async requests/commands.
- `add asyncapi publish event operation`: Inserts a new publish operation, for producing domain events.
- `add asyncapi message`: Inserts a new message, you can choose it to be either a **Request** or an **Event**.Once snippets are inserted use the `` key to travel between snippet placeholders.
## Paste as Schema
You can also autogenerate an Schema object from a JSON example.
Right-click inside `#/components/schemas` section and choose `AsyncAPI: Paste as Schema` from the context menu.

### Credits
AsyncAPI Viewer utilizes the following open source projects:
- [@asyncapi/asyncapi-react](https://github.com/asyncapi/asyncapi-react/tree/next)
### Contributors
Ivan Garcia Sainz-Aja [ivangsa](https://github.com/ivangsa)