canvas-openapi

Auto-generated OpenAPI 3.0.3 specification for the Canvas LMS REST API.

Overview

This spec was generated from a local Canvas LMS instance built from source, covering 1005 paths across all Canvas REST API endpoints. It provides a machine-readable description of the full Canvas API surface.

Authentication

The spec includes a Bearer Token authentication scheme. Generate a token in Canvas under Account > Settings > Approved Integrations, then pass it as:

Authorization: Bearer <your_token>

Usage

• Swagger UI -- Load the spec file to browse and test endpoints interactively
• Postman -- Import the spec to generate a complete Canvas API collection
• Code generation -- Use openapi-generator or similar tools to generate client libraries in any language

# Example: generate a Python client
openapi-generator-cli generate -i openapi.json -g python -o ./canvas-client