flask-rest-jsonapi-next

flask-rest-jsonapi-next is an extension for Flask that adds support for quickly building REST APIs with huge flexibility around the JSONAPI 1.0 specification. It is designed to fit the complexity of real life environments so flask-rest-jsonapi-next helps you to create a logical abstraction of your data called “resource” and can interface any kind of ORMs or data storage through data layer concept.

It was forked from miLibris/flask-rest-jsonapi with main goals of introducing new features and fixing some of the bugs we’d encountered.

Main concepts

* JSON API 1.0 specification: it is a very popular specification about client server interactions for REST JSON API. It helps you work in a team because it is very precise and sharable. Thanks to this specification your API offers lots of features like a strong structure of request and response, filtering, pagination, sparse fieldsets, including related objects, great error formatting etc.

* Logical data abstraction: you usually need to expose resources to clients that don’t fit your data table architecture. For example sometimes you don’t want to expose all attributes of a table, compute additional attributes or create a resource that uses data from multiple data storages. flask-rest-jsonapi-next helps you create a logical abstraction of your data with Marshmallow / marshmallow-jsonapi so you can expose your data through a very flexible way.

* Data layer: the data layer is a CRUD interface between your resource manager and your data. Thanks to it you can use any data storage or ORMs. There is an already full featured data layer that uses the SQLAlchemy ORM but you can create and use your own custom data layer to use data from your data storage(s). You can even create a data layer that uses multiple data storages and ORMs, send notifications or make any custom work during CRUD operations.

User’s Guide

This part of the documentation will show you how to get started in using flask-rest-jsonapi-next with Flask.

• Installation
• Features
  • Upstream features
  • About fork
    • Exception handling
    • decorators in Resource
    • configurable POST and PATCH Resource schema
    • Optional support for model.validate()
    • less strict requirements on Content-Type HTTP header
    • support IN operator in simple filters
  • Compared to other similar projects
    • Flask-RESTful
    • Flask-Restless
• Quickstart
  • First example
  • Classical CRUD operations
    • Create object
    • List objects
    • Update object
    • Delete object
  • Relationships
    • Create object with related object(s)
    • Update object and his relationships
    • Create relationship
    • Delete relationship
• Logical data abstraction
• Resource Manager
  • Required attributes
  • Optional attributes
  • ResourceList
  • ResourceDetail
  • ResourceRelationship
• Data layer
  • SQLAlchemy
  • Custom data layer
• Routing
• Filtering
  • SQLAlchemy
  • Simple filters
• Include related objects
• Sparse fieldsets
• Pagination
  • Size
  • Number
  • Size + Number
  • Disable pagination
• Sorting
  • Multiple sort
  • Descending sort
  • Multiple sort + Descending sort
• Errors
• Api
• Permission
• OAuth
• Configuration
• Working with SQLAlchemy 2.x data layers

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

• Index

• Module Index