No project description provided
Project description
Installation
pip install flask-rest-framework
Test
py.test .
Overview
flask-rest-framework is inspired by Django REST framework
You can use this extension to develop your rest api quickly based on flask, each view contains this:
- Authentication policies
- Permission
- Throttle
and each of them can be customized yourself, all of those are revolved around User
, so you can define your own
User class.
Example
from flask import Flask,jsonify
from flask_restframework import RestFramework
app = Flask(__name__)
rf = RestFramework()
rf.init_app(app)
from flask_restframework.views import APIView
from flask_restframework.authentication import BasicAuthentication,JWTAuthentication
from flask_restframework.permissions import AllowAny,IsAuthenticated
class PingView(APIView):
authentication_classes=[BasicAuthentication, JWTAuthentication]
permission_classes=[IsAuthenticated,]
def get(self, *args, **kwargs):
return jsonify({"args":args,"kwargs":kwargs,"request.args":request.args})
app.add_url_rule("/ping/<string:name>",view_func=PingView.as_view('ping'))
if __name__ == "__main__":
app.run()
User
if you define your own User
class, must configure it in flask config env: FLASK_RESTFRAMEWORK_USER_CLASS
app.config['FLASK_RESTFRAMEWORK_USER_CLASS] = 'your_user_class_path.YourUser'
and User
class must has is_authenticated
attribute, the type is boolean, this attribute will be used in permission.
more detail can see flask_restframework.user.BaseUser
, i recomend your class inherit from it.
we use the User
in authentication
Authenticaion
we offer BasicAuthentication
and JWTAuthentication
authentication class here, you could custom your authentication class or inherit them to complete auth
Permission
AllowAny
permission class allows anyone access your API without authentication;
IsAuthenticated
user must be authenticated before accessing API;
IsAuthenticatedOrReadOnly
allow anyone access API if request method is safe('get','head','options'), else must be authenticated.
Throttling
before using throttle, we must configure cache to app, else it will not work:
from xxx import Cache
...
app = Flask(__name__)
cache = Cache()
rf = RestFramework()
rf.init_app(app,cache)
...
here we offer AnonRateThrottle
and UserRateThrottle
.
and the rate of throttling can be set by second
,minute
,hour
,day
.
...
class YourView(APIView):
authentication_classes=[BasicAuthentication, JWTAuthentication]
throttle_handlers = [{"class":AnonRateThrottle,"rate":"1/hour"},{"class":UserRateThrottle,"rate":"10/minute"}]
...
AnonRateThrottle
the AnonRateThrottle
is for throttling anonymous user, namely permission class is AllowAny
, if user is authenticated, it will not limit.
UserRateThrottle
the UserRateThrottle
is for throttling authenticated user, if user is not authenticated, it also work.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flask-rest-framework-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1ed9a933344fba3ebe7e794668653a114324e6aecc3f6f6bf73a3d07437c459 |
|
MD5 | b5c679bd51c66534c5d44ad661c1ff3a |
|
BLAKE2b-256 | fac926ac86dd83ff7077c90243759e66d903d8a02ae8ff3d95325c6e34efd9d9 |
Hashes for flask_rest_framework-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cdfc072a5724df7116d7b0bf31848757336a98080f0dc16729951c2e0157781 |
|
MD5 | 054beb70ada53d1bb51b11bccff4bcdb |
|
BLAKE2b-256 | 174e0561093ce2ef44a68a3a80f3186c19de148c1bbcea6ffd4b9a323655fd4b |