Supported OpenAPI Features/FAQs

🚧

This page has been deprecated and the information therein now lives within our comprehensive OpenAPI Compatibility Chart.

Our new API Reference Redesign adds improved support for OpenAPI features, in addition to performance increases and faster page rendering times.

Feature

Supported?

Authentication schemes - basic/header/oauth2

Yes

Bearer authentication

Yes

Top level object $refs

Yes

Nested object $refs

Yes - with infinitely nested objects (there will probably be some limit, but should be enough to do whatever you need to)

Top level array $refs

Yes

Top level primitive values

Yes

allOf/anyOf/oneOf/not

allOf, anyOf, and oneOf are supported, but not is not

Response schemas - top level object $refs

Yes

Response schemas - nested object $refs

Yes - with three nested objects

Response schemas - top level array $refs

Yes

Response schemas - top level primitive values

Yes

collectionFormat - specify array fromat

Yes

additionalProperties

Yes, preview it here and see the OAS file for reference.

Multiple authentication schemes

Yes

Multiple server urls

Only in the API Reference Redesign

We're also rewriting this with OAS 3.0.0 support but gracefully converting older swagger file formats to be up to the latest version.

Known Issues

Apart from the missing features listed above, there are a few known issues with our Explorer. You can view them here: https://github.com/readmeio/api-explorer/issues


What’s Next
Did this page help you?