Can I import an existing OpenAPI file?

Not currently. OpenAPI generation is implemented, but import remains a planned capability.

OpenAPI output

Use OpenAPI with Mock API Studio

Every running local project generates an OpenAPI 3 document from its configured resources, operations, response shapes, query behavior, authentication schemes, and relationship routes. Inspect the JSON directly or use the bundled Swagger UI.

Start building free View documentation

Open the generated API description

Start the local runtime, then request /openapi.json from the same localhost origin. The document describes the currently synchronized mock configuration.

Shell

curl http://localhost:4000/openapi.json

# Interactive Swagger UI
open http://localhost:4000/docs

What appears in the document?

The generated description includes the project name, configured resource paths and methods, response shapes, pagination and query parameters, authentication schemes, and nested relationship routes. Disabled operations are not advertised.

Use Swagger UI with protected routes

Open /docs on the local runtime and use Authorize with the API key, Basic credentials, or bearer token configured for the project. Auth endpoints remain public according to the project settings.

Understand import support

Mock API Studio currently generates OpenAPI output; it does not yet import an OpenAPI document into a project. Create and bind TypeScript models in the dashboard, then use the generated document to inspect or integrate the running mock.

Keep exploring

Last updated September 17, 2026. Product behavior described here is verified against the current Mock API Studio runtime.