Web Frameworks

​

Available Frameworks

​

How Framework Plugins Work

1. Type Generation - Creates TypeScript types for requests, responses, and parameters
2. Framework Integration - Generates code using framework-specific patterns and APIs
3. Type Safety - Ensures compile-time type checking for your API implementation
4. Developer Experience - Provides autocomplete and inline documentation

​

Choosing a Framework Plugin

​

Angular Plugin

• HTTP Requests - HttpRequest instances for use with Angular’s HTTP client
• HTTP Resources - Resource APIs using Angular’s new httpResource API
• Injectable Services - Classes decorated with @Injectable for dependency injection

​

Fastify Plugin

• Route Handlers - Type-safe handler signatures matching your API operations
• Request Typing - Body, query, path, and header parameter types
• Response Typing - Success and error response types

​

Common Configuration

import { defineConfig } from '@hey-api/openapi-ts';

export default defineConfig({
  input: 'path/to/openapi.yaml',
  output: {
    path: './src/client',
  },
  plugins: [
    {
      name: 'framework-plugin',
      // Framework-specific options here
    },
  ],
});

​

Standard Options

​

Next Steps