About OpenAPI Explorer
OpenAPI Explorer is an open source web component for viewing OpenAPI specifications in a browser.
It is designed to be embedded in a site or application as a custom element. The project also describes automatic integration options for React and Vue.
Use our Online OpenAPI Explorer page when you want to load an OpenAPI file from a URL or from disk and see it rendered on this site.
What OpenAPI Explorer Shows
OpenAPI Explorer can render an OpenAPI file as an API explorer and console.
It can help people:
- view resources and models from the OpenAPI document
- make API calls from the rendered interface
- style the component to fit the host site
At first glance the UI doesn't seem like much, you have to click the side-bar "operations" to see the list of end point descriptions, and then you can easily navigate the API documentation and make requests.
The endpoints themselves are not shown in the side-bar, only the descriptions, so the ease of use here varies between Open API files. But this can help you decide if your descriptions are good enough stand alone representations of the endpoint.
cURL is supported as the code export format.
When To Consider OpenAPI Explorer
OpenAPI Explorer is a good fit when you want an embeddable component instead of a hosted documentation platform.
Because it is a browser UI, API calls made from the page are still affected by browser security rules such as CORS. For exploratory API testing, compare the requests it sends with a REST client or an HTTP proxy when you need stronger evidence.
Related OpenAPI Pages
Read OpenAPI for API Testing for the specification background, or compare OpenAPI Explorer with Swagger UI, Scalar, Stoplight Elements, Zudoku, and Redoc.
Try OpenAPI Explorer UI With Our APIs
Try OpenAPI Explorer UI with our APIs: