A data model from your contract

Understudy reads your contract and proposes a set of resources, each with typed fields and links, so you get a data model you can browse and edit, not just a list of routes.

A raw OpenAPI document is a list of paths and schemas. That is hard to work with when you want to manage data. So Understudy reads your contract and proposes a model of resources: Order, Customer, Product, and so on. Each one has fields you can edit and records you can browse.

What it finds

  • Resources, from the object schemas in your document and from resource-style paths. A pair like /orders and /orders/{id} becomes the resource Order.
  • Fields on each resource, with a sensible type and a required flag, read from the schema.
  • Links between resources, wherever one record points at another.

It proposes, you decide

Discovery is a starting point, not a cage. It suggests the model, and you adjust anything you like in the editor: rename a field, change a type, add a link. Your changes are kept. Re-running discovery never overwrites the edits you have made.

The result is a clear, browsable model on day one, with full control to shape it your way.