Index

_ | A | C | F | G | J | M | R | S | T | U

_

  • __init__() (jsonapi.db.table.FromItem method)
    • (jsonapi.fields.Field method)
    • (jsonapi.fields.Relationship method)
    • (jsonapi.fields.jsonapi.fields.Aggregate.Aggregate method)

A

  • access (jsonapi.model.Model attribute)

C

  • Cardinality (class in jsonapi.db.table)

F

  • Field (class in jsonapi.fields)
  • fields (jsonapi.model.Model attribute)
  • from_ (jsonapi.model.Model attribute)
  • FromItem (class in jsonapi.db.table)

G

  • get_collection() (jsonapi.model.Model method)
  • get_object() (jsonapi.model.Model method)
  • get_related() (jsonapi.model.Model method)

J

  • jsonapi (module)
  • jsonapi.fields (module)
  • jsonapi.fields.Aggregate (class in jsonapi.fields)
  • jsonapi.model (module)

M

  • MIME_TYPE (in module jsonapi.model)
  • Model (class in jsonapi.model)

R

  • Relationship (class in jsonapi.fields)

S

  • search (jsonapi.model.Model attribute)
  • search() (in module jsonapi.model)
  • SEARCH_PAGE_SIZE (in module jsonapi.model)

T

  • type_ (jsonapi.model.Model attribute)

U

  • user (jsonapi.model.Model attribute)
 

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.