-
Notifications
You must be signed in to change notification settings - Fork 103
Intro to Flask restful
homepage: https://flask-restful.readthedocs.io/en/latest/
Flask-RESTful is an extension for Flask that adds support for quickly building REST APIs. It is a lightweight abstraction that works with your existing ORM/libraries. Flask-RESTful encourages best practices with minimal setup. If you are familiar with Flask, Flask-RESTful should be easy to pick up.
or
Flask-RESTPlus http://flask-restplus.readthedocs.io/en/latest/index.html
Integrate with Flask-Restful and Swagger
http://seanlin.logdown.com/posts/247554-introduction-to-rest
https://blog.miguelgrinberg.com/post/designing-a-restful-api-using-flask-restful
好處：RequestParser
parser = reqparse.RequestParser()
parser.add_argument('rate', type=int, help='Rate cannot be converted')
parser.add_argument('name')
args = parser.parse_args()
Note
The default argument type is a unicode string. This will be str in python3 and unicode in python2.***
By default, the RequestParser tries to parse values from flask.Request.values, and flask.Request.json.
Use the location argument to add_argument() to specify alternate locations to pull the values from. Any variable on the flask.Request can be used. For example:
# Look only in the POST body
parser.add_argument('name', type=int, location='form')
# Look only in the querystring
parser.add_argument('PageSize', type=int, location='args')
# From the request headers
parser.add_argument('User-Agent', location='headers')
# From http cookies
parser.add_argument('session_id', location='cookies')
# From file uploads
parser.add_argument('picture', type=werkzeug.datastructures.FileStorage, location='files')| HTTP Method | URI | Action |
|---|---|---|
| GET | http://[hostname]/todo/api/v1.0/tasks | Retrieve list of tasks |
| GET | http://[hostname]/todo/api/v1.0/tasks/[task_id] | Retrieve a task |
| POST | http://[hostname]/todo/api/v1.0/tasks | Create a new task |
| PUT | http://[hostname]/todo/api/v1.0/tasks/[task_id] | Update an existing task |
| DELETE | http://[hostname]/todo/api/v1.0/tasks/[task_id] | Delete a task |
Refence