Python Flask 创建接口

224 阅读2分钟

Python Flask 创建接口详细整理

  • Flask 是一个轻量级的 Python Web 框架,它可以用于创建 RESTful API 接口

首先,我们需要安装 Flask:

  • 安装 Flask

pip install flask
  • 接下来,创建一个 Python 文件 app.py 并导入 Flask 模块:

from flask import Flask
  • 创建一个 Flask 应用

app = Flask(__name__)
  • 定义一个最简单的接口它将返回一个 "Hello, World!" 的消息。

from flask import Flask

app = Flask(__name__)

定义一个路由,指定访问路径为 "/"

@app.route("/")
def hello():
    return "Hello, World!"

if __name__ == "__main__":
     #运行应用
    app.run()

我们可以通过在路由中定义参数来为接口添加参数。

from flask import Flask

app = Flask(__name__)

 #定义一个带参数的路由
@app.route("/user/<name>")
def user(name):
    return f"Hello, {name}!"

if __name__ == "__main__":
    app.run()

处理 POST 请求可以通过检查请求方法来实现。

from flask import Flask, request

app = Flask(__name__)

 定义一个处理 POST 请求的路由
@app.route("/user", methods=["POST"])
def create_user():
     从请求中获取 JSON 数据
    data = request.get_json()

     #在这里处理用户的创建逻辑
     ...

    return "User created successfully"

if __name__ == "__main__":
    app.run()

返回 JSON 响应Flask 内置了 jsonify 函数,可以方便地将字典转换为 JSON 格式。

from flask import Flask, jsonify

app = Flask(__name__)

 #返回 JSON 格式的响应
@app.route("/user/<name>")
def get_user(name):
    user = {
        "name": name,
        "age": 25,
        "email": "example@gmail.com"
    }

    # 返回 JSON 格式的响应
    return jsonify(user)

if __name__ == "__main__":
    app.run()

Flask 提供了处理错误的机制,可以返回自定义的错误消息和状态码。

from flask import Flask, jsonify

app = Flask(__name__)

 #定义一个处理 404 错误的路由
@app.errorhandler(404)
def not_found_error(error):
     #返回自定义的错误消息和状态码
    return jsonify({"error": "Not found"}), 404

if __name__ == "__main__":
    app.run()

以上是一个简单的 Flask 接口的创建过程。你可以根据自己的需求和业务逻辑扩展和定制接口。