用来测试接口的 flask server

Restful规范

  1. """
  2. RESTFul url 规范，参考：http://www.pythondoc.com/flask-restful/second.html
  4. ==========  ===============================================  =============================
  5. HTTP 方法   URL                                              动作
  6. ==========  ===============================================  ==============================
  7. GET         http://[hostname]/todo/api/v1.0/tasks            检索任务列表
  8. GET         http://[hostname]/todo/api/v1.0/tasks/[task_id]  检索某个任务
  9. POST        http://[hostname]/todo/api/v1.0/tasks            创建新任务
  10. PUT         http://[hostname]/todo/api/v1.0/tasks/[task_id]  更新任务
  11. DELETE      http://[hostname]/todo/api/v1.0/tasks/[task_id]  删除任务
  12. ==========  ================================================ =============================
  15. 命名规范：
  17. # 我们使用 SomeListHandler 命名而不是复数形式方便区分，比如 VideosHandler 和 VideoHandler 不容易区分
  18. """
  19. class TaskListHandler(BaseHandler):
  20.     def get(self):
  21.         """获取列表"""
  22.         pass
  24.     def post(self):
  25.         """创建一条新的记录"""
  26.         pass
  29. class TaskHandler(BaseHandler):
  30.     def get(self, _id):
  31.         """获取一条记录的信息"""
  32.         pass
  34.     def put(self, _id):
  35.         """更新一条记录的信息"""
  36.         pass
  38.     def delete(self, _id):
  39.         """删除一条记录"""
  40.         pass

测试 server

  1. # pip install flask Flask-RESTful
  2. from flask import Flask
  3. from flask_restful import reqparse, abort, Api, Resource
  4. from flask import request
  6. app = Flask(__name__)
  7. api = Api(app)
  9. TODOS = {
  10.     'todo1': {'task': 'build an API'},
  11.     'todo2': {'task': '?????'},
  12.     'todo3': {'task': 'profit!'},
  13. }
  16. def abort_if_todo_doesnt_exist(todo_id):
  17.     if todo_id not in TODOS:
  18.         abort(404, message="Todo {} doesn't exist".format(todo_id))
  21. parser = reqparse.RequestParser()
  22. parser.add_argument('task')
  25. # Todo
  26. # shows a single todo item and lets you delete a todo item
  27. class Todo(Resource):
  28.     def get(self, todo_id):
  29.         abort_if_todo_doesnt_exist(todo_id)
  30.         return TODOS[todo_id]
  32.     def delete(self, todo_id):
  33.         abort_if_todo_doesnt_exist(todo_id)
  34.         del TODOS[todo_id]
  35.         return '', 204
  37.     def put(self, todo_id):
  38.         args = parser.parse_args()
  39.         task = {'task': args['task']}
  40.         TODOS[todo_id] = task
  41.         return task, 201
  44. # TodoList
  45. # shows a list of all todos, and lets you POST to add new tasks
  46. class TodoList(Resource):
  47.     def get(self):
  48.         return TODOS
  50.     def post(self):
  51.         print(request.data)
  52.         args = parser.parse_args()
  53.         todo_id = int(max(TODOS.keys()).lstrip('todo')) + 1
  54.         todo_id = 'todo%i' % todo_id
  55.         TODOS[todo_id] = {'task': args['task']}
  56.         return TODOS[todo_id], 201
  59. class TaskList(Resource):
  60.     def post(self):
  61.         print(request.data)
  62.         return {"id": 1}
  65. class Ping(Resource):
  66.     def get(self):
  67.         return 'pong'
  69. ##
  70. # Actually setup the Api resource routing here
  71. ##
  72. api.add_resource(Ping, '/')
  73. api.add_resource(TodoList, '/todos')
  74. api.add_resource(Todo, '/todos/<todo_id>')
  75. api.add_resource(TaskList, '/tasks')
  78. if __name__ == '__main__':
  79.     app.run(debug=True)  # port=5000