ReadMe Documentation

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Supported OpenAPI Features/FAQs

Our new API Explorer adds improved support for some OpenAPI features that were missing, in addition to performance increases and faster page rendering times. Below is a table of features supported in the old version vs. new version of our API explorer. The form module that we are using is Mozilla's open source react-jsonschema-form, so you can also check that to visually see what we support :).

Feature

Supported Previously

Supported in new explorer

Authentication schemes - basic/header/oauth2

Yes

Yes

Bearer authentication

No

Yes

Top level object $refs

Yes

Yes

Nested object $refs

Yes (Only supports 1 level nested object references)

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

No

Yes

Top level primitive values

No

Yes

allOf/anyOf/oneOf/not

No - workaround is to combine schemas together (in the case of allOf)

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

Response schemas - top level object $refs

Yes

Yes

Response schemas - nested object $refs

Yes (Only supports 1 level nested object references)

Yes - with three nested objects

Response schemas - top level array $refs

No

Yes

Response schemas - top level primitive values

No

Yes

collectionFormat - specify array fromat

No

Yes - it will be added in later updates after launch

additionalProperties

No

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

Multiple authentication schemes

No

Yes

Multiple server urls

No

Not at the moment. If multiple server urls are defined, we grab the first one

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



Did this page help you?