教你如何构建简单Web API("手把手教你快速构建简单Web API")

原创

ithorizon 7个月前 (10-19) 阅读数 19 #后端开发

手把手教你迅速构建明了Web API

一、Web API 简介

Web API（Application Programming Interface，应用程序编程接口）是一套协议，允许应用程序之间进行交互。通过Web API，开发者可以方便地获取远程服务器上的数据，实现数据的增删改查等操作。本文将手把手教你怎样迅速构建一个明了的Web API。

二、构建Web API所需的工具和库

为了构建一个明了的Web API，我们需要以下工具和库：

Python：编程语言，用于编写API代码；

Flask：一个轻量级的Web框架，用于迅速搭建Web API；

requests：一个明了的HTTP库，用于发送HTTP请求。

三、安装所需的库

首先，确保你的电脑已经安装了Python。然后，在命令行中运行以下命令安装Flask和requests库：

pip install flask

pip install requests

四、创建Web API项目

在合适的位置创建一个文件夹，用于存放我们的项目文件。然后在该文件夹中创建一个名为app.py的Python文件，并编写以下代码：


from flask import Flask, jsonify, request
app = Flask(__name__)
# 定义一个明了的数据源
data = {
    "students": [
        {"name": "Alice", "age": 20, "gender": "Female"},
        {"name": "Bob", "age": 22, "gender": "Male"},
        {"name": "Charlie", "age": 21, "gender": "Male"}
    ]
}
# 定义一个路由，返回所有学生信息
@app.route('/students', methods=['GET'])
def get_students():
    return jsonify(data["students"])
# 定义一个路由，选择学生姓名查询信息
@app.route('/students/', methods=['GET'])
def get_student(name):
    for student in data["students"]:
        if student["name"] == name:
            return jsonify(student)
    return jsonify({"error": "Student not found"}), 404
# 定义一个路由，添加新的学生信息
@app.route('/students', methods=['POST'])
def add_student():
    new_student = request.get_json()
    data["students"].append(new_student)
    return jsonify(new_student), 201
# 定义一个路由，更新学生信息
@app.route('/students/', methods=['PUT'])
def update_student(name):
    for student in data["students"]:
        if student["name"] == name:
            student.update(request.get_json())
            return jsonify(student)
    return jsonify({"error": "Student not found"}), 404
# 定义一个路由，删除学生信息
@app.route('/students/', methods=['DELETE'])
def delete_student(name):
    for student in data["students"]:
        if student["name"] == name:
            data["students"].remove(student)
            return jsonify({"message": "Student deleted"}), 200
    return jsonify({"error": "Student not found"}), 404
# 启动服务器
if __name__ == '__main__':
    app.run(debug=True)