Example

Examples are like Open API's "example", they are used by the plan to build requests to test your API.

When building your suite, it is possible to import examples from your schema. Examples can be updated at any time and changes will apply to future plans.

Unlike examples from a schema, it is possible to generate examples dynamically using a specific example format.

Example types

Regular A static example that does not change
Dynamic Generated with the plan, in runtime.

See the examples guide to learn more

Try for free
Legal