API References

%product% generates beautiful and powerful API References from your API definitions. Create, upload or edit your OpenAPI definitions directly on %product%.

See our own API References here.

Features

Your beautiful API References consist of:

• A title heading with a summary.
• All available server URLs.
• Authentication methods.
• All the operations listed grouped by tags.
• All webhooks (OAS 3.1).

Every operation shows the following:

• Summary and information.
• Headers.
• Request and response media types.
• Query parameters, path parameters, body data and form data.
• Response codes and response bodies.
• Property constraints.
• Auto-generated example request using different libraries.
• Auto-generated example responses.
• Callbacks.

You can directly link to the API references from the documentation by following the steps in page linking.

Try It Out

Readers can try out your API right from the API Reference.

API Reference Personalisation

You can personalise your API references, so your readers do not have to fetch the dynamic variables out from different places. See variables and personalised docs for implementation.

Supported Specifications

We support OpenAPI 2/3 (Swagger). We also support Webhooks in OAS 3.1.

File Type

These types are supported:

• JSON files - .json
• YAML files - .yaml