MichalLytek/type-graphql
Type Graphql
Type-graphql is a toolkit and framework for creating type-safe GraphQL APIs. It functions as a schema generator and resolver library that uses TypeScript classes and decorators as the primary source of truth for data structures and query logic.
The project enables the definition of GraphQL schemas and resolvers through typed classes rather than manual schema definition language. This approach ensures that TypeScript types automatically align with the GraphQL schema to prevent runtime errors.
The framework provides capabilities for API implementation, including input data validation and access control through guards. It further supports resolver organization via dependency injection and controller classes.
Features
- GraphQL APIs - Provides a framework for exposing data models through automatically generated type-safe GraphQL interfaces.
- GraphQL Schema Generation - Provides a framework to generate GraphQL schemas and resolvers using TypeScript classes and decorators as the source of truth.
- GraphQL - Provides a library for implementing GraphQL queries and mutations via typed controller classes.
- Schema Generation - Uses class decorators to automatically derive GraphQL schemas from TypeScript metadata at runtime.
- Single-Source-of-Truth Modeling - Uses TypeScript classes as the shared primary definition for both data models and the GraphQL schema.
- Field Resolvers - Implements field resolvers within controller classes to handle data fetching and mutations.
- GraphQL Schema Definitions - Defines GraphQL schemas and types using TypeScript classes to maintain a single source of truth.
- Schema-First Development Frameworks - Prioritizes typed classes as the source of truth for generating the GraphQL schema and logic.
- Type-Safe API Frameworks - Leverages the TypeScript static type system to ensure the GraphQL schema and API contracts align.
- Resolver Mappings - Maps GraphQL queries and mutations to specific methods within controller classes using metadata reflection.
- Access Control Guards - Uses guards to block unauthorized requests to specific GraphQL resolvers based on security policies.
- Input Validation - Verifies and sanitizes incoming GraphQL arguments against defined rules to ensure data integrity.
- Dependency Injection Containers - Provides an inversion-of-control container to decouple business logic from GraphQL resolvers.
- Dependency Injection - Decouples business logic from the API by injecting required service dependencies into resolvers.
- Metadata Reflection Frameworks - Utilizes reflect-metadata to dynamically inspect decorated class properties for schema generation.
- Request Interception Middleware - Implements a chain of guards and validation functions that intercept requests before they reach resolvers.
- Controller-Based Organization - Structures business logic and data fetching using class-based controllers and dependency injection.
- Web Framework Integrations - TypeScript-based framework for building GraphQL APIs.
- Web Frameworks - Framework for creating GraphQL APIs using TypeScript classes and decorators.
