Skip to content

OpenAPI ​

vlatte openapi turns an OpenAPI spec into mock files the vlatte command serves: a mock API that answers every operation of the spec, with no code to write. It reads OpenAPI 3.0, 3.1 and 3.2, in JSON or YAML, from a file or an http(s) URL.

sh
vlatte openapi --in petstore.yaml --out testdata/vlatte/_mocks
vlatte --addr=127.0.0.1:8080
curl http://127.0.0.1:8080/pets/3fa85f64-5717-4562-b3fc-2c963f66afa6
# {"ageMonths":30,"breed":"meadow cedar","color":"amber",...}

testdata/vlatte/_mocks is the folder vlatte serves by default, so the second command needs no flags.

What you get ​

For each operation of the spec, the mocks:

  • Reply with each response the spec declares, in each of its media types: the spec's examples, or made-up values that fit the schemas, the same on every run. See Replies.
  • Refuse requests that break the spec, as the real server would: 401 without the credential the operation asks for, 415 for a body in a media type it doesn't take, 400 or 422 for parameters or a body that don't fit their schemas, and 405 for a method the path doesn't have. See Requests that break the spec.
  • Negotiate content: a client gets the media type its Accept header prefers, or a 406 when the operation has none it takes.

Everything else vlatte does works on top: verify what a client sent, add faults or delays, and change mocks while the server runs through the admin API.

When to use it ​

Start from the spec when you have one, and the mocks cover every operation from the first run. Then write mocks by hand only for what a test needs that the spec can't say, such as a particular answer for one ID: hand-written mocks win over generated ones. To mock a service from what it actually answers instead, record it.

Next steps ​