Python实现API开发的详细教程_Python

一、检查python环境和安装flask

1.1 确保python和pip已安装

首先，你需要确保你的计算机上已经安装了python和pip。在大多数现代操作系统中，python和pip通常会一起安装。你可以通过在命令行（终端或命令提示符）中输入以下命令来检查它们是否已安装。

1.1.1 检查python是否安装

按住键盘键“win+r”，输入cmd，再回车。

输入以下代码，检查python是否安装：

python --version

1.1.2 检查pip是否安装

再输入以下代码，检查pip是否安装：

pip --version

1.2. 升级pip（可选）

虽然这不是必需的，但升级pip到最新版本是一个好习惯，因为它可能包含重要的错误修复和新功能。你可以使用以下命令来升级pip

打开pycharm，找到terminal，输入以下代码，升级pip

pip install --upgrade pip

1.3. 安装flask

现在你可以使用pip来安装flask了。在命令行中输入以下命令

pip install flask

成功的样式：

1.4. 验证安装

安装完成后，你可以通过运行一个简单的flask应用来验证flask是否已成功安装。在命令行中创建一个新的python文件（例如main.py），并添加以下代码：

from flask import flask
 
app = flask(__name__)
 
@app.route('/')
def hello_world():
    return 'hello, world!'
 
if __name__ == '__main__':
    app.run(debug=true)

如果flask已正确安装，你应该会在浏览器中看到一个显示“hello, world!”的页面（默认情况下，flask应用会在http://127.0.0.1:5000/运行），点开弹出链接：

页面显示的结果，则表示安装成功：

二、创建一个简单的flask应用程序

2.1 获取所有项目的列表（get /items）

from flask import flask, jsonify, request
 
app = flask(__name__)
 
items = [
    {"id": 1, "name": "item 1", "description": "this is item 1"},
    {"id": 2, "name": "item 2", "description": "this is item 2"},
]
 
 
# 获取所有项目（get请求）
@app.route('/items', methods=['get'])
def get_items():
    return jsonify(items), 200
 
if __name__ == '__main__':
    app.run(debug=true)

结果展示：

输入：http://127.0.0.1:5000/items

2.2 根据id获取单个项目（get /items/<item_id>）

# 获取单个项目（get请求）
@app.route('/items/<int:item_id>', methods=['get'])
def get_item(item_id):
    item = next((item for item in items if item['id'] == item_id), none)
    if item is none:
        return jsonify({"error": "item not found"}), 404
    return jsonify(item), 200

结果展示：

输入：http://127.0.0.1:5000/items/2

2.3 创建一个新项目（post /items）

# 创建新项目（post请求）
@app.route('/items', methods=['post'])
def create_item():
    if not request.json or not 'name' in request.json:
        return jsonify({"error": "bad request"}), 400
    new_item = {
        "id": items[-1]['id'] + 1 if items else 1,
        "name": request.json['name'],
        "description": request.json.get('description', "")
    }
    items.append(new_item)
    return jsonify(new_item), 201

使用 python 的 requests 库来发送 post 请求。以下是一个简单的示例：

import requests
import json
 
url = 'http://127.0.0.1:5000/items'
headers = {'content-type': 'application/json'}
data = {'name': 'new item', 'description': 'this is a new item'}
 
response = requests.post(url, headers=headers, data=json.dumps(data))
print(response.status_code)
print(response.json())

结果展示：

输入：http://127.0.0.1:5000/items

2.4 更新现有项目（put /items/<item_id>）

# 更新现有项目（put请求）
@app.route('/items/<int:item_id>', methods=['put'])
def update_item(item_id):
    item = next((item for item in items if item['id'] == item_id), none)
    if item is none:
        return jsonify({"error": "item not found"}), 404
    if not request.json:
        return jsonify({"error": "bad request"}), 400
    item['name'] = request.json.get('name', item['name'])
    item['description'] = request.json.get('description', item['description'])
    return jsonify(item), 200

2.5 删除项目（delete /items/<item_id>）

# 删除项目（delete请求）
@app.route('/items/<int:item_id>', methods=['delete'])
def delete_item(item_id):
    global items
    items = [item for item in items if item['id'] != item_id]
    return jsonify({"result": true}), 200

以上就是python实现api开发的详细教程的详细内容，更多关于python实现api开发的资料请关注代码网其它相关文章！