Does this handle compound documents with included?

Yes. The top-level included array becomes a typed array of related resources. Each unique type in included produces its own interface so you can narrow on resource.type when walking relationships.

Will it work for collections (data: [])?

Yes. Paste a collection response and the data array's element shape is inferred. Single-resource and collection documents only differ in whether data is an object or array.

What about jsonapi.org sparse fieldsets?

Sparse fieldsets just remove fields. Generate types from a request that includes every field your client cares about — fields not present in the sample will not appear in the interface.

JSON→TypeScript

JSON:API to TypeScript

Paste any JSON:API document — single resource, collection, or compound document with included — and get TypeScript interfaces for data, attributes, relationships, and links.

JSON input valid

TypeScript output

About this conversion

JSON:API (jsonapi.org) imposes a strict envelope: every resource has a type, an id, an attributes bag, an optional relationships bag, and optional links. Compound documents add a top-level included array carrying related resources. Hand-typing this in TypeScript is tedious, especially when the attributes shape varies by resource type. Pasting a real document — pulled from your API or from your fixture file — generates accurate interfaces in one paste.

The result lets you narrow on data.type, type-safely access attributes, and walk relationships into the included array. For applications consuming Ember Data, JSON:API-compliant Rails APIs, or Laravel JSON:API, this is the fastest way to bootstrap a typed client without committing to a heavyweight code-generation pipeline.

JSON:API to TypeScript

About this conversion

Same shape, other validators

Other JSON shapes