OpenAPI/AsyncAPI View

[thawankeane]

Hello everyone,

This idea may be out of scope due to a specific JSON format, but here it goes:

It is a very common need for developers who work on building or integrating with APIs documented in OpenAPI (aka Swagger) and AsyncAPI specifications to visualize these specifications in a more visually compatible interface instead of raw JSON.

The idea behind this discussion is to add a new view into JSON Hero to render these specifications into a visually compatible interface when JSON Hero detects that the parsed JSON is in one of these specification formats.

Some useful resources:

• SwaggerHub has an open-source online OpenAPI editor that may be used in this view to render both OpenAPI and AsyncAPI JSON files, and supports a ?url= query param to load a file from a URL.
  • They also have a simpler OpenAPI visualizer called Swagger UI with a live preview available at petstore.swagger.io that also supports the ?url= query, but this one accepts only OpenAPI files, not AsyncAPI.
• AsyncAPI has a tool called AsyncAPI Studio that also could be used to render AsyncAPI files. They also support the ?url= query to load JSON from a URL.