Flask Web API构建实例：GET、POST文件上传、静态资源下载一网打尽

 

以下是一个通过 Flask 构建 Web API 服务的详细示例，包含了各类请求（GET、POST、文件上传、静态资源下载）、每个方法独立配置路由、参数接收和解析、请求日志记录以及异常日志记录。请确保你已经安装了 Flask，你可以使用以下命令进行安装：

pip install Flask

接下来是一个包含详细注释的源代码示例：

from flask import Flask, request, send_from_directory
import logging

app = Flask(__name__)

# 配置日志
logging.basicConfig(filename='api.log', level=logging.DEBUG, format='%(asctime)s [%(levelname)s] - %(message)s')

# 定义路由和资源
@app.route('/hello', methods=['GET', 'POST'])
def hello_world():
    if request.method == 'GET':
        # 记录请求日志
        logging.info('GET 请求收到')
        return {'message': '你好，世界！'}
    elif request.method == 'POST':
        # 获取请求中的参数
        data = request.get_json()

        # 记录请求日志
        logging.info(f'POST 请求收到，数据：{data}')

        # 模拟处理数据
        try:
            result = data['input'] * 2
            return {'result': result}
        except KeyError as e:
            # 记录异常日志
            logging.error(f'请求数据中缺少键: {e}')
            return {'error': '无效的请求数据'}, 400

# 文件上传
@app.route('/upload', methods=['POST'])
def upload_file():
    # 获取上传的文件
    file = request.files['file']

    # 记录请求日志
    logging.info(f'文件上传请求收到: {file.filename}')

    # 保存文件到服务器
    file.save(f'uploads/{file.filename}')

    return {'message': '文件上传成功'}

# 静态资源下载
@app.route('/static/<path:filename>')
def serve_static(filename):
    return send_from_directory('static', filename)

# 启动应用
if __name__ == '__main__':
    app.run(debug=True)

在这个例子中：

• /hello 路由包含了 GET 和 POST 方法，演示了如何获取请求中的参数，并记录请求日志和异常日志。
• /upload 路由处理了文件上传请求，将文件保存到服务器的 uploads 目录中，并记录请求日志。
• /static/<path:filename> 路由配置用于提供静态资源下载。

你可以通过以下方式进行测试：

• GET 请求：http://127.0.0.1:5000/hello
• POST 请求：http://127.0.0.1:5000/hello，请求体为 JSON 格式的数据。
• 文件上传：使用 POST 请求 http://127.0.0.1:5000/upload，并在请求中添加一个文件。
• 静态资源下载：http://127.0.0.1:5000/static/example.txt（示例文件名）。

运行这个脚本后，你可以在浏览器或工具中查看返回的数据，并在脚本所在目录下的 api.log 文件中找到日志记录。这个示例提供了一个基本框架，你可以根据实际需求扩展和修改。