Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apicurio/apicurio-registry-vscode-plugin

A plugin for accessing Apicurio Registry information from vscode.
https://github.com/apicurio/apicurio-registry-vscode-plugin

Last synced: about 1 month ago
JSON representation

A plugin for accessing Apicurio Registry information from vscode.

Host: GitHub
URL: https://github.com/apicurio/apicurio-registry-vscode-plugin
Owner: Apicurio
License: apache-2.0
Created: 2023-12-07T14:53:31.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-04-19T13:03:00.000Z (9 months ago)
Last Synced: 2024-11-05T10:47:39.517Z (3 months ago)
Language: TypeScript
Size: 1.91 MB
Stars: 0
Watchers: 6
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Roadmap: ROADMAP.md

Awesome Lists containing this project

README

        # Apicurio Registry Explorer

[![Current Version](https://img.shields.io/visual-studio-marketplace/v/apicurio.apicurio-registry-explorer.svg?color=emerald&label=Visual%20Studio%20Marketplace&logo=visual-studio-code&logoColor=blue&style=flat)][marketplace]

![Install Count](https://img.shields.io/visual-studio-marketplace/i/apicurio.apicurio-registry-explorer.svg?color=emerald&style=flat)

![downloads Count](https://img.shields.io/visual-studio-marketplace/d/apicurio.apicurio-registry-explorer.svg?color=emerald&style=flat)

[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/apicurio/apicurio-registry-vscode-plugin.svg?color=emerald&label=release&logoColor=white&logo=github&labelColor=grey)][github]

![license](https://img.shields.io/badge/license-Apache_2-brightgreen.svg)

![Apicurio](/resources/apicurio_icon.png)

Explore any [Apicurio registry V2](https://www.apicur.io/registry/) with ease on your IDE.

## Features

![Apicurio](/resources/apicurio-explorer.png)

### Explore registry

- [X] Explore groups

- [X] Explore artifacts by ID or Names (see settings)

- [X] Search artifacts

- [X] Explore artifacts versions

- [X] Explore artifacts metas

- [X] Preview artifacts versions on your IDE

- [X] Preview OPENAPI with swaggerPreview (using [swagger-viewer](https://marketplace.visualstudio.com/items?itemName=Arjun.swagger-viewer) if available)

![Apicurio](/resources/gif/preview-artifact.gif)

### Content Edition

- [X] Add new artifacts

- [X] Add artifact versions

- [X] Edit artifacts versions metas

- [X] Edit artefacts versions state

- [X] Delete artifacts

![Apicurio](/resources/gif/add-artifact.gif)

![Apicurio](/resources/gif/edit-metas.gif)

## Installation

### Extension Marketplace

This extension is published in the [VSCode marketplace][marketplace].

1. Run [Install Extensions][Install Extensions] from the [Command Palette][Command Palette]

2. Search and choose  .

Also available on [open-vsx.org][openvsx].

## Settings

- `apicurio.http.secure` : Acces to Apicurio registry API over http or https.

- `apicurio.http.host` : Apicurio registry host.

- `apicurio.http.path` : Apicurio registry path.

- `apicurio.http.port` : Apicurio registry port.

- `apicurio.search.limit` : Custom search limit (increase Apicurio default).

- `apicurio.explorer.name` : Display name (if exist) instead of ID in registry explorer view.

- `apicurio.versions.reverse` : Reverse Versions order by default.

- `apicurio.tools.preview.format` : Format document on preview.

- `apicurio.tools.preview.OPENAPI` : Use or not Swagger-preview if [swagger-viewer](https://marketplace.visualstudio.com/items?itemName=Arjun.swagger-viewer) plugin is available for OPENAPI.

## Using multiples registries

If you use differents registries on different projects, use Workspace settings to override defaults.

You car use the the `Settings` > `Workspace` > `Apicurio` pannel or create a `.vscode/setttings.json` file.

## Release Notes

See [Changelog][Changelog].

## Known Issues

[GitHub issues][issues]

Feel free to report any [issues][new issue].

## Related Projects

See [apicurio.io](https://www.apicur.io/)

## License

[Apache-2.0 license][license]

## Contribute

Contributions welcome.

Kindly contributed from the original project to the Apicurio organization by [jetmartin][jetmartin].

[humans txt][humanstxt]

[jetmartin]: https://github.com/jetmartin

[github]: https://github.com/Apicurio/apicurio-registry-vscode-plugin

[issues]: https://github.com/Apicurio/apicurio-registry-vscode-plugin/issues

[new issue]: https://github.com/Apicurio/apicurio-registry-vscode-plugin/issues/new

[Changelog]: https://github.com/Apicurio/apicurio-registry-vscode-plugin/blob/main/CHANGELOG.md

[humanstxt]: https://github.com/Apicurio/apicurio-registry-vscode-plugin/blob/main/humans.txt

[license]: https://github.com/Apicurio/apicurio-registry-vscode-plugin/blob/main/LICENSE

[marketplace]: https://marketplace.visualstudio.com/items?itemName=apicurio.apicurio-registry-explorer

[openvsx]: https://open-vsx.org/extension/apicurio/apicurio-registry-explorer

[openvsx-dt]: https://img.shields.io/open-vsx/dt/apicurio/apicurio-registry-explorer

[command palette]: https://code.visualstudio.com/Docs/editor/codebasics#_command-palette

[install extensions]: https://code.visualstudio.com/docs/editor/extension-gallery#_install-an-extension