User Guide

Learn how to use cannula effectively. The following sections descibe the different parts of cannula to assist in creating a well structued GraphQL API.

Getting Started

• Code Generation
  • Configuration
  • Schema Metadata
  • Generated Code
  • Example
  • Relationship Queries
  • Running
• Resolvers
  • Using the API
  • CannulaAPI
  • ParseResults
• Context
  • Context Reference
  • Context
  • ResolveInfo
• Datasources
  • ORM Data Source
  • DatabaseRepository
  • HTTP Data Source
  • HTTPDataSource

Working with schema

• Scalars
  • Built-in Scalars
  • Custom Scalars
• Schema Utilities
• Extension
• assert_has_query_and_mutation()
• build_and_extend_schema()
• ensure_schema_has_directive()
• load_schema()

Advanced Tools

• Contrib
  • Config
  • BaseConfig
  • alias()
  • OpenTelemetry Integration
  • InstrumentedCannulaAPI
  • create_instrumented_api()
  • resolve_name()
  • trace_field_resolver()
  • trace_middleware()
• Middleware
  • Debug Middleware
• Testing
• Developer Guide
  • Architecture Overview
  • Data Flow
  • Schema Analysis
  • Type System
  • Code Generation Base
  • AST Generation
  • Extending the System
  • Best Practices
  • Common Tasks
  • Error Handling
  • Development Workflow
  • Contributing
  • Further Reading