/ Feature — OpenAPI import

Assert reads your OpenAPI file and writes one monitor per operation

You wrote the file once, in OpenAPI or Swagger. Assert takes the method, the path, a sample body from the schema examples, and a status assertion from the documented response.

/ What the import produces

Twelve operations, twelve monitors

Assert writes the assertions your schema already implies: the documented status code, the response shape, the required fields. You can change any of them before you save.

  • Method, path and path parameters come straight from the specification.
  • Assert builds the sample request body from your schema examples.
  • Each operation gets a status assertion from its documented response.
  • Where your specification defines a response schema, the monitor checks the body against it.
Configuring an imported monitor
openapi.yaml 12 operations found
GET /api/users
POST /api/users
GET /api/users/{id}
PUT /api/users/{id}
DELETE /api/users/{id}
GET /api/orders
+ 6 MORE OPERATIONS
/ Three steps

From file to first result

01

Upload or link the file

Drag the file in, or paste a URL Assert can reach. JSON and YAML both work.

02

Review the operations

Each one shows up with its method, its path and the assertions Assert derived. Deselect the ones you do not want.

03

Start the checks

Assert creates one monitor per operation you kept, on the interval and in the regions you picked. The first results arrive within a minute.

/ Formats

What Assert can read

OpenAPI 3.1

The current version. Assert reads the components, the schemas and the examples.

OpenAPI 3.0

Assert reads it the same way, down to per-operation servers and security schemes.

Swagger 2.0

Assert converts it on import, so the endpoints and parameters come through intact.

JSON or YAML

Either serialisation, from a file upload or a URL that Assert can reach.

/ When it pays off

Documentation that does a second job

A new API

Import the specification the day you publish it, and Assert watches every endpoint before your first consumer calls one.

After a deployment

Re-import to pick up the new operations. Assert tells you which ones are new and which ones changed.

The forgotten endpoint

Every documented operation gets a monitor, including the one nobody remembered to test.

Microservices

Import one specification per service and keep every service on the same interval.

Third-party APIs

Monitor a dependency from its published specification, and hear about its outage before your users do.

Contract testing

Assert that the running service still matches the schema it publishes.

Import the spec. Get the coverage.

Five monitors, thirty-second checks, no card, no call.