Welcome to pg-jsonapi’s documentation!¶

pg-jsonapi is an asynchronous Python library for building JSON API v1.0 compliant calls using a very simple declarative syntax.

Table of Contents

  • Introduction
    • Quick Start
  • Defining Models
    • Custom Fields
    • Multiple Tables
    • Relationships
    • Aggregate Fields
  • Fetching Data
    • Single Objects
    • Collections
    • Related Objects
    • Sparse Fieldsets
    • Inclusion of Related Resources
    • Sorting
    • Pagination
    • Filtering
  • Protecting Models
  • Searching
    • A Single Model
    • Multiple Models
  • API Reference
    • Models
    • From Items
    • Fields
 

Logo

pg-jsonapi

Build JSON API v1.0 compliant RESTFul api for PostgreSQL backends. Powered by asyncpgsa, SQLAlchemy Core, and marshmallow libraries.

Navigation

Table of Contents

  • Introduction
    • Quick Start
  • Defining Models
    • Custom Fields
    • Multiple Tables
    • Relationships
    • Aggregate Fields
  • Fetching Data
    • Single Objects
    • Collections
    • Related Objects
    • Sparse Fieldsets
    • Inclusion of Related Resources
    • Sorting
    • Pagination
    • Filtering
  • Protecting Models
  • Searching
    • A Single Model
    • Multiple Models
  • API Reference
    • Models
    • From Items
    • Fields

Related Topics

  • Documentation overview

Quick search

©2019, Omar Zabaneh. | Page source