API Status: Offline
Documentation

OpenAPI / Swagger ImportPremium

If you already have an OpenAPI specification, you can import it directly to generate a complete Rest Faker project without manually defining each route.

Supported Formats

OpenAPI 3.x
JSON or YAML
Swagger 2.x
JSON or YAML

How to Import

1

Open the Import dialog

From your project list, click the Import OpenAPI button.

2

Paste or upload your spec

Paste the spec text directly, or upload a .json, .yaml, or .yml file.

3

Preview & select routes

Rest Faker parses the spec and shows every detected route with its mapped fields. Deselect any routes you don't need.

4

Confirm import

Give the project a name and click Import. A new project is created with all selected routes ready to use.

Automatic Field Mapping

Rest Faker automatically maps spec field types and common field names to the appropriate Faker.js generators so your mock data looks realistic out of the box.

Type-based mapping
format: email internet.email
format: date-time → date.recent
format: uri → internet.url
format: uuid → string.uuid
Name-based mapping
firstName, lastName → person.firstName / lastName
price, amount → commerce.price
avatar, image → image.avatar
phone, mobile → phone.number

Fields that cannot be mapped are flagged as unmapped in the preview — you can assign them manually before confirming.

Premium Feature

OpenAPI import is available on the Startup and Enterprise plans. Free plan users can still build projects manually using the Route Creator.