什么是 RESTful API？
RESTful API 是一种基于 HTTP 协议，用于实现客户端与服务器之间数据交互的软件架构风格。它是一种轻量级、可扩展、易于维护和理解的 API 设计方式，具有很好的可读性和可测试性。
Flask 简介
Flask 是一个 Python Web 开发框架，它基于 Werkzeug WSGI 工具箱和 Jinja2 模板引擎。Flask 具有简单、灵活、可扩展的特点，适合快速开发原型和小型应用。
实现 RESTful API 的完整步骤
1. 安装 Flask
使用 pip 安装 Flask：
pip install Flask
2. 创建 Flask 应用
from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello_world():
return 'Hello, World!'3. 创建资源
// javascriptcn.com 代码示例
from flask import Flask, jsonify, request
app = Flask(__name__)
tasks = [
{
'id': 1,
'title': 'Buy groceries',
'description': 'Milk, Cheese, Pizza, Fruit, Tylenol',
'done': False
},
{
'id': 2,
'title': 'Learn Python',
'description': 'Need to find a good Python tutorial on the web',
'done': False
}
]
@app.route('/tasks', methods=['GET'])
def get_tasks():
return jsonify({'tasks': tasks})
@app.route('/tasks', methods=['POST'])
def create_task():
task = {
'id': tasks[-1]['id'] + 1,
'title': request.json['title'],
'description': request.json.get('description', ""),
'done': False
}
tasks.append(task)
return jsonify({'task': task}), 201
@app.route('/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
task = [task for task in tasks if task['id'] == task_id]
if len(task) == 0:
abort(404)
return jsonify({'task': task[0]})
@app.route('/tasks/<int:task_id>', methods=['PUT'])
def update_task(task_id):
task = [task for task in tasks if task['id'] == task_id]
if len(task) == 0:
abort(404)
task[0]['title'] = request.json.get('title', task[0]['title'])
task[0]['description'] = request.json.get('description', task[0]['description'])
task[0]['done'] = request.json.get('done', task[0]['done'])
return jsonify({'task': task[0]})
@app.route('/tasks/<int:task_id>', methods=['DELETE'])
def delete_task(task_id):
task = [task for task in tasks if task['id'] == task_id]
if len(task) == 0:
abort(404)
tasks.remove(task[0])
return jsonify({'result': True})4. 运行 Flask 应用
if __name__ == '__main__':
app.run(debug=True)5. 测试 RESTful API
使用 Postman 工具测试 RESTful API。
GET 请求
请求 URL：
http://localhost:5000/tasks
响应结果：
// javascriptcn.com 代码示例
{
"tasks": [
{
"description": "Milk, Cheese, Pizza, Fruit, Tylenol",
"done": false,
"id": 1,
"title": "Buy groceries"
},
{
"description": "Need to find a good Python tutorial on the web",
"done": false,
"id": 2,
"title": "Learn Python"
}
]
}POST 请求
请求 URL：
http://localhost:5000/tasks
请求参数：
{
"title": "Learn Flask",
"description": "Need to find a good Flask tutorial on the web"
}响应结果：
{
"task": {
"description": "Need to find a good Flask tutorial on the web",
"done": false,
"id": 3,
"title": "Learn Flask"
}
}PUT 请求
请求 URL：
http://localhost:5000/tasks/3
请求参数：
{
"title": "Learn Flask",
"description": "Find a good Flask tutorial on the web",
"done": true
}响应结果：
{
"task": {
"description": "Find a good Flask tutorial on the web",
"done": true,
"id": 3,
"title": "Learn Flask"
}
}DELETE 请求
请求 URL：
http://localhost:5000/tasks/3
响应结果：
{
"result": true
}总结
本文详细介绍了使用 Flask 框架实现 RESTful API 的完整步骤，包括安装 Flask、创建 Flask 应用、创建资源、运行 Flask 应用和测试 RESTful API 等方面。通过本文的学习，读者可以了解 RESTful API 的基本概念和 Flask 框架的基本用法，掌握如何使用 Flask 框架实现 RESTful API，并了解如何使用 Postman 工具测试 RESTful API。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/657e9c0fd2f5e1655d9739b5