APIs

The API explorer turns an OpenAPI 3.0 or 3.1 description - or an older Swagger 2.0 one, in JSON or YAML - into documentation and a console in one: every operation by tag with a filter, its parameters, request body and responses, and every schema as a table of fields, with references followed and limits spelled out.

Try any operation: parameters are checked against their schemas before anything is sent, the body starts from the description's example, credentials are kept in memory only, and the answer comes back with its status, time, headers and body, checked against the documented schema. Every request is also written as cURL, JavaScript, C# and Python, with secrets replaced by placeholders. A mock mode answers from the description's own examples.

An orders API, mocked

A fictional trade counter's orders API in OpenAPI 3.1, in mock mode: nothing leaves the page. Try "Get an order" without authorising to see the 401, authorise with any key, then try again; change an amount to a word and see the field marked before anything is sent.

Get the code
<script src="/assets/bmx-components.min.js"></script>

<bmx-api-explorer id="ae-orders" mock selected="getOrder" style="--bmx-api-explorer-height: 46rem"></bmx-api-explorer>

A Swagger 2.0 description, read only

An older Swagger 2.0 description of a stock service, shown as documentation only (try-it="false"): the request body and responses as field tables, with the pattern and the limits written out.

Get the code
<script src="/assets/bmx-components.min.js"></script>

<bmx-api-explorer id="ae-stock" try-it="false" selected="reserveStock" style="inline-size: 100%; --bmx-api-explorer-height: 36rem"></bmx-api-explorer>