graphql/graphiql
Graphiql
GraphiQL is an interactive browser-based integrated development environment for writing, testing, and documenting GraphQL queries and mutations. It functions as a code editor, an API exploration tool, and a schema explorer, providing a visual interface for browsing GraphQL types and fields.
The project provides a language server that delivers schema-driven autocompletion, linting, and validation via the Language Server Protocol. It allows for the embedding of high-performance editors into external projects and supports the injection of custom tools and components through a sidebar plugin API.
The toolset covers broad capabilities for language intelligence, including syntax highlighting and real-time error reporting. It also includes systems for schema management, theme customization via CSS variables, and the persistence of editor state.
Features
- API Playgrounds - Provides an interactive browser-based IDE for writing and testing GraphQL queries and mutations.
- GraphQL Integrated Development Environments - Provides a complete interactive browser-based IDE for writing, testing, and documenting GraphQL queries and mutations.
- Interactive API Explorers - Provides an interactive browser interface for testing and validating GraphQL queries and mutations.
- GraphQL Development Tools - Supports a workflow of writing and executing GraphQL operations inline to iterate on data requests.
- Code Intelligence - Provides schema-driven code completion, hover documentation, and real-time validation.
- High-Performance Code Editors - Provides a high-performance code editor specifically optimized for writing and analyzing GraphQL operations.
- GraphQL Language Services - Implements a comprehensive language service providing schema-driven autocompletion, linting, and validation for GraphQL.
- Language Server Protocols - Implements the Language Server Protocol to deliver diagnostics and autocompletion for GraphQL files.
- Language Servers - Implements a GraphQL language server that provides autocompletion, diagnostics, and navigation via LSP.
- Schema Browsers - Offers a searchable interface for browsing GraphQL type definitions and fields to understand data structures.
- Schema Explorers - Ships a searchable interface for browsing GraphQL schema types and fields to understand available data structures.
- Type-Aware Autocompletion - Generates valid fields, arguments, and types based on the active schema while the user types.
- GraphQL Linting - Identifies syntax errors and linting violations in GraphQL documents to provide immediate feedback.
- Schema Validation - Validates GraphQL queries and variables by comparing the AST against a loaded schema definition.
- Variable Validation - Checks JSON variables against a generated schema based on declared operations to ensure correct input types.
- Background Analysis Workers - Offloads heavy parsing and language analysis to web workers to maintain UI thread responsiveness.
- Code Formatting Tools - Ships a configurable formatting engine to ensure consistent styling across GraphQL files.
- Definition Navigation - Enables jumping directly to fragment definitions, input types, and enums within a project.
- Inline Operation Execution - Allows users to execute GraphQL operations directly from source files and view results inline.
- Live Schema Refreshing - Allows refreshing the schema used for linting and autocomplete dynamically without reloading the editor instance.
- Syntax Highlighters - Provides color-coding of GraphQL operations and bracket matching to improve query readability.
- Custom Validation Rules - Implements a configuration system for defining custom directives and validation rules for GraphQL analysis.
- Dynamic Schema Mapping - Maps specific files or directories to different GraphQL schemas using match expressions for multi-model projects.
- Extensible Plugin Architectures - Provides a plugin-based architecture to inject custom tools and components into the sidebar.
- Template Literal Parsing - Extracts and analyzes GraphQL syntax embedded within template literals of other programming languages.
- Embedded Editor Components - Allows embedding the high-performance Monaco editor with full GraphQL support into external projects.
- Plugin APIs - Provides an API for integrating custom tools and UI components into the sidebar.
- Language Service Workers - Supports injecting custom parsers and validation rules by deploying personalized web workers.
- Schema Explorers - Ships a visual interface for browsing GraphQL types, fields, and documentation to understand API data structures.
- Outils de développement - In-browser IDE for exploring GraphQL schemas and queries.
