Logo
NeoArc Studio

GraphQL API Documentation

Document GraphQL APIs with full support for queries, mutations, subscriptions, custom scalars, directives, and interfaces. Configure authentication with OAuth2, API keys, and custom headers.

The GraphQL API documentation tooling covers the full schema surface. Document your GraphQL schema with full support for operations (queries, mutations, subscriptions), custom scalars, directives, and interfaces. Configure authentication using OAuth2, API keys, bearer tokens, or custom headers.

Why Document GraphQL APIs in NeoArc

  • Visual Editors - Define operations, scalars, directives, and interfaces through dedicated editors rather than hand-editing SDL files
  • Schema Integration - Reference your data schemas for argument and return types
  • Full Security Support - Configure Bearer tokens, API keys, OAuth2 with scopes, and custom headers
  • Subscription Support - Document real-time operations with trigger descriptions and WebSocket configuration
  • Directive System - Define custom directives with all 19 GraphQL locations supported
  • Data Lineage - Trace API fields back to source schemas and entities

GraphQL Editors

Six dedicated editors are available for GraphQL API documentation:

Operation Types

GraphQL defines three operation types, each with specific purposes:

File Structure

GraphQL API documentation is stored as JSON files:

  • API Definition - your-api.graphql-api.json containing servers, security schemes, scalars, directives, and interfaces
  • Operations - Individual *.graphql-operation.json files for each query, mutation, or subscription

Operations are stored in a definitions/ subfolder alongside the main API definition.

Getting Started

Ready to document your first GraphQL API? Follow the getting started guide to create an API definition, configure security, and add operations.

Related Content