Welcome to Flask-JSONRPC’s documentation!

Flask-JSONRPC brings full JSON-RPC 2.0 support to your Flask applications. It is designed to feel natural to anyone who already knows Flask, and easy to learn for those who do not.

Flask-JSONRPC provides:

• a Pythonic decorator-based API for defining JSON-RPC methods

• automatic request parsing and parameter handling

• validation based on Python type hints

• batch request support

• method namespacing

• an optional built-in web UI explorer for testing and debugging, available here

• an extension system that plays nicely with the Flask ecosystem

Flask-JSONRPC follows the JSON-RPC 2.0 specification and integrates naturally with Flask’s routing, blueprints, and application factory patterns.

User’s Guide

• Installation
  • Requirements
  • Installation
  • Verifying the Installation
  • Upgrading
• Quickstart
  • A Minimal Application
  • Calling Your Method
  • Using Parameters
  • Keyword Parameters
  • Using the Built-in Web Explorer
• Tutorial
  • Step 1: Creating the Application
  • Step 2: Declaring Methods
  • Step 3: Parameters and Type Checking
  • Step 4: Error Handling
• Methods
  • Declaring Methods
  • Method Naming Conventions
  • Docstrings
  • Returning Values
  • Raising Errors
• Parameters
  • Positional Parameters
  • Keyword Parameters
  • Defaults
  • Varargs
• Types and Validation
  • Supported Types
  • Return Type Validation
  • Custom Validation with jsonschema
  • Using Pydantic (Optional Extension)
• Blueprints
  • Basic Blueprint Example
  • Blueprint Namespaces
  • Multiple Endpoints
• Batch Requests
  • Example Batch Request
  • Notifications in Batch
• Errors
  • Raising Errors
  • Error Structure
  • Custom Exception Classes
• Explorer UI
  • Features
  • Disabling the Explorer
  • Custom Explorer Pages (Advanced)
• Application Factories
  • Creating an Application Factory
  • Benefits
• Authentication Patterns
  • Token-based Authentication
  • JWT Authentication (Optional Extension)
• Advanced Validation
  • Using JSON Schema
  • Using Pydantic Models
• Marshaling and Serialization
  • Returning Custom Objects
  • Integration with Marshmallow
• Testing Flask-JSONRPC Applications
  • Using Flask’s Test Client
  • Batch Requests Testing
  • Mocking Dependencies
• Deployment
  • WSGI Servers
  • Reverse Proxy (Nginx Example)
  • HTTPS and Security
  • Scaling and Multiple Instances

API Reference

• API Reference
  • flask_jsonrpc
  • flask_jsonrpc package
  • flask_jsonrpc.conf package
  • flask_jsonrpc.types package
  • flask_jsonrpc.contrib package
  • flask_jsonrpc.contrib.browse package
  • flask_jsonrpc.contrib.openrpc package