Angularv19

Beta Leave feedback · Contribute

About

Angular is a web framework that empowers developers to build fast, reliable applications.

The Angular plugin for Hey API generates HTTP requests and resources from your OpenAPI spec, fully compatible with validators, transformers, and all core features.

Collaborators

• Max Scopp

Features

• Angular v19 support
• seamless integration with @hey-api/openapi-ts ecosystem
• generate HTTP requests
• generate HTTP resources
• minimal learning curve thanks to extending the underlying technology

Installation

In your configuration, add @angular/common to your plugins and you’ll be ready to generate Angular artifacts. 🎉

openapi-ts.config.ts

export default {
  input: 'hey-api/backend', // sign up at app.heyapi.dev
  output: 'src/client',
  plugins: [
    // ...other plugins
    '@angular/common',
  ],
};

Output

The Angular plugin will generate the following artifacts, depending on the input specification.

Requests

A single function is generated for each endpoint. It returns an HttpRequest result.

example

common.gen.ts

export const addPetRequest = (options) =>
  client.requestOptions({
    method: 'POST',
    responseStyle: 'data',
    url: '/pet',
    ...options,
  });

config

openapi-ts.config.ts

export default {
  input: 'hey-api/backend', // sign up at app.heyapi.dev
  output: 'src/client',
  plugins: [
    // ...other plugins
    {
      name: '@angular/common',
      httpRequests: true,
    },
  ],
};

Resources

A single function is generated for each endpoint. It returns a result from httpResource call.

example

common.gen.ts

export const addPetResource = (options) => httpResource(() => addPetRequest(options()));

config

openapi-ts.config.ts

export default {
  input: 'hey-api/backend', // sign up at app.heyapi.dev
  output: 'src/client',
  plugins: [
    // ...other plugins
    {
      name: '@angular/common',
      httpResources: true,
    },
  ],
};

API

You can view the complete list of options in the UserConfig interface.

Examples

You can view live examples on StackBlitz or on GitHub.