Flask RESTful Flask HTTPAuth
4 likes1,254 views
The document provides examples of using Flask-RESTful and Flask-HTTPAuth to create a RESTful API in Python. It includes code snippets for basic functionalities such as creating, reading, updating, and deleting (CRUD) tasks, along with examples of user authentication. The document also contains references and notes on best practices for building APIs with these frameworks.
![fromflaskimportFlask,request
fromflask.ext.restfulimportResource,Api
app=Flask(__name__)
api=Api(app)
todos={}
#----------------------------------
classTodoSimple(Resource):
defget(self,todo_id):
return{todo_id:todos[todo_id]}
defput(self,todo_id):
todos[todo_id]=request.form['data']
return{todo_id:todos[todo_id]}
#----------------------------------
api.add_resource(TodoSimple,'/<string:todo_id>')
#----------------------------------
if__name__=='__main__':
app.run(debug=True)
127.0.0.1--[23/Nov/201504:41:41]"PUT/todo1HTTP/1.1"
127.0.0.1--[23/Nov/201504:47:57]"GET/todo1HTTP/1.1"
Example #2
$curlhttp://localhost:5000/todo1-d"data=Rememberthemilk"
{"todo1":"Rememberthemilk"}
$curlhttp://localhost:5000/todo1
{"todo1":"Rememberthemilk"}
4 / 20](https://image.slidesharecdn.com/flaskrestful-httpauth-151128114514-lva1-app6891/85/Flask-RESTful-Flask-HTTPAuth-4-320.jpg)
![fromflaskimportFlask
fromflask.ext.restfulimportreqparse,abort,Api,Resource
app=Flask(__name__)
api=Api(app)
TODOS={
'todo1':{'task':'buildanAPI'},
'todo2':{'task':'?????'},
'todo3':{'task':'profit!'},
}
#----------------------------------
defabort_if_todo_doesnt_exist(todo_id):
iftodo_idnotinTODOS:
abort(404,message="Todo{}doesn'texist".format(todo_id))
parser=reqparse.RequestParser()
parser.add_argument('task',type=str)
#----------------------------------
classTodoList(Resource):
defget(self):
returnTODOS
defpost(self):
args=parser.parse_args()
todo_id=int(max(TODOS.keys()).lstrip('todo'))+1
todo_id='todo%i'%todo_id
TODOS[todo_id]={'task':args['task']}
returnTODOS[todo_id],201
Example #3
#singleitem;get,updateanddelete
classTodo(Resource):
defget(self,todo_id):
abort_if_todo_doesnt_exist(todo_id)
returnTODOS[todo_id]
defdelete(self,todo_id):
abort_if_todo_doesnt_exist(todo_id)
delTODOS[todo_id]
return'',204
defput(self,todo_id):
args=parser.parse_args()
task={'task':args['task']}
TODOS[todo_id]=task
returntask,201
#----------------------------------
api.add_resource(TodoList,'/todos')
api.add_resource(Todo,'/todos/<todo_id>')
#----------------------------------
if__name__=='__main__':
app.run(debug=True)
6 / 20](https://image.slidesharecdn.com/flaskrestful-httpauth-151128114514-lva1-app6891/85/Flask-RESTful-Flask-HTTPAuth-6-320.jpg)
![127.0.0.1--[23/Nov/201505:15:54]"GET/todosHTTP/1.1"
127.0.0.1--[23/Nov/201505:17:14]"GET/todos/todo3HTTP/1.
127.0.0.1--[23/Nov/201505:17:36]"DELETE/todos/todo2HTTP
127.0.0.1--[23/Nov/201505:17:59]"GET/todos/todo2HTTP/1.
127.0.0.1--[23/Nov/201507:38:07]"POST/todosHTTP/1.1"
127.0.0.1--[23/Nov/201507:38:56]"GET/todos/todo4HTTP/1.
127.0.0.1--[23/Nov/201507:39:41]"PUT/todos/todo4HTTP/1.
$curlhttp://localhost:5000/todos
$curlhttp://localhost:5000/todos/todo3
#verbose
$curlhttp://localhost:5000/todos/todo2-XDELETE-v
$curlhttp://localhost:5000/todos-d"task=somethingnew"-X
$curlhttp://localhost:5000/todos/todo3-d"task=somethingdi
7 / 20](https://image.slidesharecdn.com/flaskrestful-httpauth-151128114514-lva1-app6891/85/Flask-RESTful-Flask-HTTPAuth-7-320.jpg)
![fromsimplexmlimportdumps
fromflaskimportmake_response,Flask
fromflask_restfulimportApi,Resource
#------------------------------------------
defoutput_xml(data,code,headers=None):
resp=make_response(dumps({'response':data}),code)
resp.headers.extend(headersor{})
returnresp
#------------------------------------------
app=Flask(__name__)
api=Api(app,default_mediatype='application/xml')
api.representations['application/xml']=output_xml
#------------------------------------------
classHello(Resource):
defget(self,entry):
return{'hello':entry}
#------------------------------------------
api.add_resource(Hello,'/<string:entry>')
#------------------------------------------
if__name__=='__main__':
app.run(debug=True)
Example #4
fromrequestsimportget
get('http://localhost:5000/me').content#default_mediatype
#Chromeok,Postmandefaultjson
get('http://localhost:5000/me',headers={"accept":"application
get('http://localhost:5000/me',headers={"accept":"application
8 / 20](https://image.slidesharecdn.com/flaskrestful-httpauth-151128114514-lva1-app6891/85/Flask-RESTful-Flask-HTTPAuth-8-320.jpg)
![fromflaskimportFlask
fromflask_httpauthimportHTTPBasicAuth
app=Flask(__name__)
auth=HTTPBasicAuth()
users={
"john":"hello",
"susan":"bye"
}
#----------------------------------
@auth.get_password
defget_pw(username):
ifusernameinusers:
returnusers.get(username)
returnNone
#----------------------------------
@app.route('/')
@auth.login_required
defindex():
return"Hello,%s!"%auth.username()
#----------------------------------
if__name__=='__main__':
app.run(debug=True)
Example #1
127.0.0.1--[23/Nov/201518:24:07]"GET/HTTP/1.1"401-
127.0.0.1--[23/Nov/201518:24:32]"POST/HTTP/1.1"405-
127.0.0.1--[23/Nov/201518:26:37]"GET/HTTP/1.1"401-
127.0.0.1--[23/Nov/201518:27:30]"GET/HTTP/1.1"200-
127.0.0.1--[23/Nov/201518:27:42]"GET/HTTP/1.1"401-
127.0.0.1--[23/Nov/201518:27:49]"GET/HTTP/1.1"200-
11 / 20](https://image.slidesharecdn.com/flaskrestful-httpauth-151128114514-lva1-app6891/85/Flask-RESTful-Flask-HTTPAuth-11-320.jpg)
![Example #2
#http://john:hello@localhost:5000
127.0.0.1--[24/Nov/201515:47:55]"GET/HTTP/1.1"401-
127.0.0.1--[24/Nov/201515:47:55]"GET/HTTP/1.1"200-
#Notes
#Postmanfailed!
#Todos:HTTPie,requests
fromflaskimportFlask
fromflask_httpauthimportHTTPDigestAuth
app=Flask(__name__)
app.config['SECRET_KEY']='secretkeyhere'
auth=HTTPDigestAuth()
#----------------------------------
users={
"john":"hello",
"susan":"bye"
}
#----------------------------------
@auth.get_password
defget_pw(username):
ifusernameinusers:
returnusers.get(username)
returnNone
#----------------------------------
@app.route('/')
@auth.login_required
defindex():
return"Hello,%s!"%auth.username()
#----------------------------------
if__name__=='__main__':
app.run()
12 / 20](https://image.slidesharecdn.com/flaskrestful-httpauth-151128114514-lva1-app6891/85/Flask-RESTful-Flask-HTTPAuth-12-320.jpg)
![fromflaskimportFlask,jsonify,abort,make_response
fromflask.ext.restfulimportApi,Resource,reqparse,fields,marshal
fromflask.ext.httpauthimportHTTPBasicAuth
#app=Flask(__name__,static_url_path="")->404
app=Flask(__name__)
api=Api(app)
auth=HTTPBasicAuth()
#--------------------------------------------------
@auth.get_password
defget_password(username):
ifusername=='miguel':
return'python'
returnNone
@auth.error_handler
defunauthorized():
#return403insteadof401topreventbrowsersfromdisplayingthedefault
#authdialog
returnmake_response(jsonify({'message':'Unauthorizedaccess'
#--------------------------------------------------
#--------------------------------------------------
api.add_resource(TaskListAPI,'/todo/api/v1.0/tasks',endpoint=
api.add_resource(TaskAPI,'/todo/api/v1.0/tasks/<int:id>',endpoint=
#--------------------------------------------------
if__name__=='__main__':
app.run(debug=True)
Example #1
Part 1,2
tasks=[
{
'id':1,
'title':u'Buygroceries',
'description':u'Milk,Cheese,Pizza,Fruit,Tylenol'
'done':False
},
{
'id':2,
'title':u'LearnPython',
'description':u'NeedtofindagoodPythontutorialo
'done':False
}
]
#--------------------------------------------------
task_fields={
'title':fields.String,
'description':fields.String,
'done':fields.Boolean,
'uri':fields.Url('task')
}
15 / 20](https://image.slidesharecdn.com/flaskrestful-httpauth-151128114514-lva1-app6891/85/Flask-RESTful-Flask-HTTPAuth-15-320.jpg)
![Part 3,4
classTaskListAPI(Resource):
decorators=[auth.login_required]
def__init__(self):
self.reqparse=reqparse.RequestParser()
self.reqparse.add_argument('title',type=str,required=
help='Notasktitleprovided'
location='json')
self.reqparse.add_argument('description',type=str,default=
location='json')
super(TaskListAPI,self).__init__()
defget(self):
return{'tasks':[marshal(task,task_fields)fortask
defpost(self):
args=self.reqparse.parse_args()
task={
'id':tasks[-1]['id']+1,
'title':args['title'],
'description':args['description'],
'done':False
}
tasks.append(task)
return{'task':marshal(task,task_fields)},201
classTaskAPI(Resource):
decorators=[auth.login_required]
def__init__(self):
self.reqparse=reqparse.RequestParser()
self.reqparse.add_argument('title',type=str,location
self.reqparse.add_argument('description',type=str,lo
self.reqparse.add_argument('done',type=bool,location
super(TaskAPI,self).__init__()
defget(self,id):
task=[taskfortaskintasksiftask['id']==id]
iflen(task)==0:abort(404)
return{'task':marshal(task[0],task_fields)}
defput(self,id):
task=[taskfortaskintasksiftask['id']==id]
iflen(task)==0:abort(404)
task=task[0]
args=self.reqparse.parse_args()
fork,vinargs.items():
ifvisnotNone:
task[k]=v
return{'task':marshal(task,task_fields)}
defdelete(self,id):
task=[taskfortaskintasksiftask['id']==id]
iflen(task)==0:abort(404)
tasks.remove(task[0])
return{'result':True}
16 / 20](https://image.slidesharecdn.com/flaskrestful-httpauth-151128114514-lva1-app6891/85/Flask-RESTful-Flask-HTTPAuth-16-320.jpg)
![The APIs
HTTP Method URI Endpoint Action
GET /todo/api/v1.0/tasks tasks Retrieve list of tasks
POST /todo/api/v1.0/tasks tasks Create a new task
GET /todo/api/v1.0/tasks/[task_id] task Retrieve a task
PUT /todo/api/v1.0/tasks/[task_id] task Update an existing task
DELETE /todo/api/v1.0/tasks/[task_id] task Delete a task
17 / 20](https://image.slidesharecdn.com/flaskrestful-httpauth-151128114514-lva1-app6891/85/Flask-RESTful-Flask-HTTPAuth-17-320.jpg)
Flask RESTful Flask HTTPAuth
- 1. Flask-RESTful Flask-HTTPAuth Eueung Mulyana http://eueung.github.io/python/flask-restful Python CodeLabs | Attribution-ShareAlike CC BY-SA 1 / 20
- 2. Flask-RESTful 2 / 20
- 10. Flask-HTTPAuth 10 / 20
- 14. Tuts by @miguelgrinberg 14 / 20
- 17. The APIs HTTP Method URI Endpoint Action GET /todo/api/v1.0/tasks tasks Retrieve list of tasks POST /todo/api/v1.0/tasks tasks Create a new task GET /todo/api/v1.0/tasks/[task_id] task Retrieve a task PUT /todo/api/v1.0/tasks/[task_id] task Update an existing task DELETE /todo/api/v1.0/tasks/[task_id] task Delete a task 17 / 20
- 18. Notes Marshalling RequestParser: define the arguments and how to validate them. A side benefit of letting Flask-RESTful do the validation is that now there is no need to have a handler for the bad request code 400 error, this is all taken care of by the extension. Example #1 18 / 20
- 19. References Designing a RESTful API using Flask-RESTful Code Repo @github 19 / 20
- 20. END Eueung Mulyana http://eueung.github.io/python/flask-restful Python CodeLabs | Attribution-ShareAlike CC BY-SA 20 / 20