Status

[felix1m]

Hey there,

this project sounds pretty interesting. Have you made any progress on it?

[ColtonProvias]

I'm currently pulling the code out of a larger project of mine and am cleaning it up. It depends on SQLAlchemy-JSONAPI, but I'm trying to alter it so other serializers can be added on later.

So far the code I have has working GET (with filtering and sorting), POST, and DELETE endpoints. PATCH is still in the works.

In the meantime, I recommend checking out SQLAlchemy-JSONAPI which I'm still releasing updates to in tandem with this. I hope to get 0.1 of this out in the next week or two.

[felix1m]

thanks for your quick answer, sounds great!

I already took a look at SQLAlchemy-JSONAPI and love the way it serializes.
But as far as i understand it does not provide an implementation of the provided querying syntax, nor deserializing.

I'd also love to see this used in combination with flask-classy and would be willing to contribute.

[ColtonProvias]

The querying syntax is planned for version 0.2 on SQLAlchemy-JSONAPI and deserialization for 0.3. I want to get one way working first before I start on the reverse.

I haven't actually considered flask-classy for this. Instead, I was just using a larger class and then pulling from that. So far I've just been pulling and trying to build from a larger project, so it's still a tad bit of a mess here as I work on cleaning up up. The goal is to make it very quick and easy to implement. For example right now in my mess of code, I have it simplified to:

from flask.ext.jsonapi import FlaskJSONAPI, SQLAlchemyEndpoint
from flask.ext.sqlalchemy import SQLAlchemy
from sqlalchemy_jsonapi import JSONAPIMixin

# ...

api = FlaskJSONAPI(app)
db = SQLAlchemy(app)

# ...

class User(JSONAPIMixin, db.Model):
    __tablename__ = 'users'

# ...

api.add_endpoint(SQLAlchemyEndpoint(User))

Of course SQLAlchemyEndpoint is extendable and is built upon JSONAPIEndpoint, which provides a base to build other endpoints on.

I'm happy for any contributions! I'm going to look into flask-classy. Feel free to contribute to SQLAlchemy-JSONAPI in the meantime while I continue to get code ready for this.

[felix1m]

sounds great, will look into SQLAlchemy-JSONAPI directly as it obviously is the better place for querying and deserialization.

[ColtonProvias]

@felix1m I just want to give you an update that querying syntax is currently in the process of being implemented into SQLAlchemy-JSONAPI. So far the fields and sort arguments have been added, leaving just the includes argument left. Filtering, however, is best done to the query prior to it being provided to the serializer since the JSON API spec isn't specific on how filtering should be done across relationships.