Import from OpenAPI

Zerq can import an existing OpenAPI 3.0 or 3.1 specification and automatically create a Collection with all its Proxies pre-configured. This is the fastest way to onboard an existing API.

What gets imported

OpenAPI field	Zerq equivalent
info.title	Collection name
servers[0].url	Target endpoint
Each path + method	A Proxy
operationId or path	Proxy name
summary / description	Proxy description
parameters	Path and query parameters
requestBody.content.*.schema	Request schema
responses.*.content.*.schema	Response schema
examples	Example values in Developer Portal

Importing

1. Go to Collections in the sidebar
2. Click Import from OpenAPI
3. Upload your OpenAPI file (.json, .yaml, or .yml)
4. Review the preview — Zerq shows which endpoints will be created
5. Click Import

All created proxies start in draft status. Review and publish them individually.

Supported formats

• OpenAPI 3.0.x (JSON and YAML)
• OpenAPI 3.1.x (JSON and YAML)

note

OpenAPI 2.0 (Swagger) is not supported. Convert to 3.x first using a tool like swagger2openapi.

After importing

• Set the correct Target Endpoint if it differs from the spec's servers URL
• Attach Credentials if your backend requires authentication
• Add Custom Headers if needed
• Review each proxy's path and target path
• Publish the proxies you want to go live

Exporting OpenAPI

You can also generate an OpenAPI 3.1 spec from any existing collection:

1. Open the collection
2. Click Download OpenAPI

This generates a spec from your proxy definitions, including all paths, methods, parameters, and schemas. This is useful for sharing API contracts with partners or importing into tools like Postman or Stoplight.