Flask-RESTful API develop

We need install flask-restful first: pip install flask-restful. then develop api.py:

from flask import Flask
from flask_restful import reqparse, abort, Api, Resource

app = Flask(__name__)
api = Api(app)

TODOS = {
    'todo1': {'task': 'build an API'},
    'todo2': {'task': '?????'},
    'todo3': {'task': 'profit!'},
}


def abort_if_todo_doesnt_exist(todo_id):
    if todo_id not in TODOS:
        abort(404, message="Todo {} doesn't exist".format(todo_id))

parser = reqparse.RequestParser()
parser.add_argument('task')

# shows a single todo item and lets you delete a todo item
class Todo(Resource):
    def get(self, todo_id):
        abort_if_todo_doesnt_exist(todo_id)
        return TODOS[todo_id]

    def delete(self, todo_id):
        abort_if_todo_doesnt_exist(todo_id)
        del TODOS[todo_id]
        return '', 204

    def put(self, todo_id):
        args = parser.parse_args()
        task = {'task': args['task']}
        TODOS[todo_id] = task
        return task, 201


# TodoList
# shows a list of all todos, and lets you POST to add new tasks
class TodoList(Resource):
    def get(self):
        return TODOS

    def post(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']}
        return TODOS[todo_id], 201

##
## Actually setup the Api resource routing here
##
api.add_resource(TodoList, '/todos')
api.add_resource(Todo, '/todos/<todo_id>')


if __name__ == '__main__':
    app.run(debug=True)
$ python api.py 
* Running on http://127.0.0.1:5000/ * Restarting with reloader
GET the list
$ curl http://localhost:5000/todos 
GET a single task
$ curl http://localhost:5000/todos/todo3
DELETE a task
$ curl http://localhost:5000/todos/todo2 -X DELETE -v
Add a new task
$ curl http://localhost:5000/todos -d "task=something new" -X POST -v
Update a task
$ curl http://localhost:5000/todos/todo3 -d "task=something different" -X PUT -v
Or you can do same thing in Postman, POST to add new task and PUT to update a task.

Leave a Reply

Your email address will not be published. Required fields are marked *