Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/souhailas/oas2tree

OAS2Tree
https://github.com/souhailas/oas2tree

Last synced: 1 day ago
JSON representation

OAS2Tree

Host: GitHub
URL: https://github.com/souhailas/oas2tree
Owner: souhailaS
Created: 2024-06-23T09:07:40.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-06-23T09:23:40.000Z (7 months ago)
Last Synced: 2024-06-23T10:34:26.085Z (7 months ago)
Size: 9.14 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# OAS-2-Tree Visual Studio Code Extension
[Download the extension](https://marketplace.visualstudio.com/items?itemName=oas2tree.oas-2-tree) from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=oas2tree.oas-2-tree).

oas-2-tree-example OAS-2-Tree is an extension for Visual Studio Code (desktop), aiming at providing core features to visualize Web APIs described in OpenAPI. The extension works with OpenAPI v2.0 and v3.0 definitions and has basic support for OpenAPI v3.1.

# Usage
1. Open Visual Studio Code.
2. Open an OpenAPI description or create a new JSON/YAML file.
3. Click on the tree icon found on the top right side of the editor to show the tree visualization on the side.

## Features
OAS-2-Tree transforms the API description into a visual tree representation, to give a rapid overview of the API's structure.

* Preview OpenApi specs as trees in a side web view panel.
* Full support of OpenAPI v3.0 and Swagger v2.0.

oas-2-tree-example

* Live generation of the visualization.

oas-2-tree-example

* Supports visualization of files with internal and external references.
* Validates the specification and shows the validation errors.

oas-2-tree-example

---

[@DESIGN Research Group](https://design.inf.usi.ch/) (USI), Lugano, Switzerland