TypeScript Interfaces

The TypeScript Generator allows you to create TypeScript interfaces that you can embed in any TypeScript-enabled project (React, Vue.js, Angular..).

To do so, run the generator:

npm init @api-platform/client --generator typescript https://demo.api-platform.com src/ --resource foo
# Replace the URL with the entrypoint of your Hydra-enabled API.

src/ is where the interfaces will be generated.

Omit the resource flag to generate files for all resource types exposed by the API. You can also use an OpenAPI documentation with -f openapi3.

This command parses the Hydra documentation and creates one .ts file for each API Resource you have defined in your application, in the interfaces subfolder.

Note: If you are not sure what the entrypoint is, see Troubleshooting.

Example

Assuming you have 2 resources in your application, Foo and Bar, when you run:

npm init @api-platform/client --generator typescript https://demo.api-platform.com src/

You will obtain 2 .ts files arranged as following:

  • src/

    • interfaces/
    • foo.ts
    • bar.ts

What' new?

API platform conference 2022

Sep 15,16 2022: new edition of our conference dedicated to API Platform and its ecosystem!