msarfati/dodecahedron

:six_pointed_star: A Flask-Based RESTful API framework :six_pointed_star:

🔯 Dodecahedron 🔯

📃 MIT License

✒️ Copyright (c) 2016 Michael Sarfati

Status: Pre-alpha

⁉️ What's this?

• A fork of 🚀 Flask-Diamond web framework, forked for pedagogical purposes.
• Inspired as well by Sinatra and NodeJS

📋 Getting started

1. Clone project

git clone [email protected]:msarfati/dodecahedron.git

2. Make the virtual environment

mkvirtualenv -a . --always-copy dodecahedron

3. Install and test

make install && make db && make test

4. Run the server

make server

📈 Current Direction

Strong RESTful API Support

• Adhere more strictly to RESTful principles:
  • Architectural Styles and the Design of Network-based Software Architectures by Roy Fielding
  • RESTful Web APIs by Leonard Richardson and Mike Amundsen
  • REST CookBook
  • REST API Tutorial: Status Codes
  • HATEOAS compliance
• RESTful code generation based on models and simplify model creation with generation scripts

TODO

• Versioning: Embed in the header

• Pagination: Limit collection queries to some number (25?) globally. Support limit and offset, embed into query.
• Query GET response: api.dodecahedron.net/book?fields=title,author will return {"title": "my title", "author": [{"id": 1, "href": "..."} ]}
• Resource references / linking - in addition to returning object as JSON, return a href linking to the exact resource. Also, if there are any explicit relations, include 'href'
• REST metaclass supporting HTTP verbs: POST, GET, PUT, DELETE, and possibly PATCH and HEAD
• ✅ reqparse is deprecated, integrate Marshmallow
• ✅ Auto-generate schemas from models with Marshmallow-SQLAlchemy

Conveniences

• Better dbshell support