Python 30 天：第 29 天 -- 构建 API

最新推荐文章于 2024-08-05 21:40:55 发布
最新推荐文章于 2024-08-05 21:40:55 发布
阅读量130 收藏
点赞数
分类专栏： python30天 文章标签： flask python 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_62599387/article/details/129781247
版权

<< 第 28 天 || 第 30 天 >>

第 29 天

构建API

在本节中，我们将介绍一个 RESTful API，它使用 HTTP 请求方法来获取、放置、发布和删除数据。

RESTful API 是一种应用程序接口 (API)，它使用 HTTP 请求来获取、放置、发布和删除数据。在前面的章节中，我们了解了 python、flask 和 mongoDB。我们将使用我们获得的知识使用 python flask 和 mongoDB 开发 RESTful API。每个具有 CRUD（创建、读取、更新、删除）操作的应用程序都有一个 API 来创建数据、获取数据、更新数据或从数据库中删除数据。

浏览器只能处理get请求。因此，我们必须有一个工具可以帮助我们处理所有请求方法（GET、POST、PUT、DELETE）。

在 API 开发方面，Postman是一个非常流行的工具。所以，如果你喜欢做这个部分，你需要下载 postman。Postman 的另一种选择是Insomnia。

API的结构 

API 端点是一个 URL，可以帮助检索、创建、更新或删除资源。结构如下所示： 示例：https: //api.twitter.com/1.1/lists/members.json 返回指定列表的成员。只有经过身份验证的用户拥有指定列表，才会显示私人列表成员。公司名称后跟版本，后跟 API 的用途。方法：HTTP 方法和 URL

API 使用以下 HTTP 方法进行对象操作：

GET        Used for object retrieval
POST       Used for object creation and object actions
PUT        Used for object update
DELETE     Used for object deletion

让我们构建一个 API 来收集有关 30DaysOfPython 学生的信息。我们将收集姓名、国家、城市、出生日期、技能和简历。

要实现此 API，我们将使用：

  • 邮差
  • Python
  • Flask
  • 数据库

 使用 get 检索数据

在此步骤中，让我们使用虚拟数据并将其作为 json 返回。要将其作为 json 返回，将使用 json 模块和 Response 模块。

# let's import the flask

from flask import Flask,  Response
import json

app = Flask(__name__)

@app.route('/api/v1.0/students', methods = ['GET'])
def students ():
    student_list = [
        {
            'name':'Asabeneh',
            'country':'Finland',
            'city':'Helsinki',
            'skills':['HTML', 'CSS','JavaScript','Python']
        },
        {
            'name':'David',
            'country':'UK',
            'city':'London',
            'skills':['Python','MongoDB']
        },
        {
            'name':'John',
            'country':'Sweden',
            'city':'Stockholm',
            'skills':['Java','C#']
        }
    ]
    return Response(json.dumps(student_list), mimetype='application/json')


if __name__ == '__main__':
    # for deployment
    # to make it work for both production and development
    port = int(os.environ.get("PORT", 5000))
    app.run(debug=True, host='0.0.0.0', port=port)

当您在浏览器上请求http://localhost:5000/api/v1.0/students url 时，您将得到：

当您在浏览器上请求http://localhost:5000/api/v1.0/students url 时，您将得到：

我们不显示虚拟数据，而是将 Flask 应用程序与 MongoDB 连接起来，并从 MongoDB 数据库中获取数据。

# let's import the flask

from flask import Flask,  Response
import json
import pymongo


app = Flask(__name__)

#
MONGODB_URI='mongodb+srv://asabeneh:your_password@30daysofpython-twxkr.mongodb.net/test?retryWrites=true&w=majority'
client = pymongo.MongoClient(MONGODB_URI)
db = client['thirty_days_of_python'] # accessing the database

@app.route('/api/v1.0/students', methods = ['GET'])
def students ():

    return Response(json.dumps(student), mimetype='application/json')


if __name__ == '__main__':
    # for deployment
    # to make it work for both production and development
    port = int(os.environ.get("PORT", 5000))
    app.run(debug=True, host='0.0.0.0', port=port)

通过连接烧瓶，我们可以从 thirty_days_of_python 数据库中获取学生集合数据。

[
    {
        "_id": {
            "$oid": "5df68a21f106fe2d315bbc8b"
        },
        "name": "Asabeneh",
        "country": "Finland",
        "city": "Helsinki",
        "age": 38
    },
    {
        "_id": {
            "$oid": "5df68a23f106fe2d315bbc8c"
        },
        "name": "David",
        "country": "UK",
        "city": "London",
        "age": 34
    },
    {
        "_id": {
            "$oid": "5df68a23f106fe2d315bbc8e"
        },
        "name": "Sami",
        "country": "Finland",
        "city": "Helsinki",
        "age": 25
    }
]

通过id获取文档

我们可以使用 id 访问 signle 文档，让我们使用他的 id 访问 Asabeneh。 http://localhost:5000/api/v1.0/students/5df68a21f106fe2d315bbc8b

# let's import the flask

from flask import Flask,  Response
import json
from bson.objectid import ObjectId
import json
from bson.json_util import dumps
import pymongo


app = Flask(__name__)

#
MONGODB_URI='mongodb+srv://asabeneh:your_password@30daysofpython-twxkr.mongodb.net/test?retryWrites=true&w=majority'
client = pymongo.MongoClient(MONGODB_URI)
db = client['thirty_days_of_python'] # accessing the database

@app.route('/api/v1.0/students', methods = ['GET'])
def students ():

    return Response(json.dumps(student), mimetype='application/json')
@app.route('/api/v1.0/students/<id>', methods = ['GET'])
def single_student (id):
    student = db.students.find({'_id':ObjectId(id)})
    return Response(dumps(student), mimetype='application/json')

if __name__ == '__main__':
    # for deployment
    # to make it work for both production and development
    port = int(os.environ.get("PORT", 5000))
    app.run(debug=True, host='0.0.0.0', port=port)
[
    {
        "_id": {
            "$oid": "5df68a21f106fe2d315bbc8b"
        },
        "name": "Asabeneh",
        "country": "Finland",
        "city": "Helsinki",
        "age": 38
    }
]

使用 POST 创建数据

我们使用POST请求方式创建数据

# let's import the flask

from flask import Flask,  Response
import json
from bson.objectid import ObjectId
import json
from bson.json_util import dumps
import pymongo
from datetime import datetime


app = Flask(__name__)

#
MONGODB_URI='mongodb+srv://asabeneh:your_password@30daysofpython-twxkr.mongodb.net/test?retryWrites=true&w=majority'
client = pymongo.MongoClient(MONGODB_URI)
db = client['thirty_days_of_python'] # accessing the database

@app.route('/api/v1.0/students', methods = ['GET'])
def students ():

    return Response(json.dumps(student), mimetype='application/json')
@app.route('/api/v1.0/students/<id>', methods = ['GET'])
def single_student (id):
    student = db.students.find({'_id':ObjectId(id)})
    return Response(dumps(student), mimetype='application/json')
@app.route('/api/v1.0/students', methods = ['POST'])
def create_student ():
    name = request.form['name']
    country = request.form['country']
    city = request.form['city']
    skills = request.form['skills'].split(', ')
    bio = request.form['bio']
    birthyear = request.form['birthyear']
    created_at = datetime.now()
    student = {
        'name': name,
        'country': country,
        'city': city,
        'birthyear': birthyear,
        'skills': skills,
        'bio': bio,
        'created_at': created_at

    }
    db.students.insert_one(student)
    return ;
def update_student (id):
if __name__ == '__main__':
    # for deployment
    # to make it work for both production and development
    port = int(os.environ.get("PORT", 5000))
    app.run(debug=True, host='0.0.0.0', port=port)

使用 PUT 更新

# let's import the flask

from flask import Flask,  Response
import json
from bson.objectid import ObjectId
import json
from bson.json_util import dumps
import pymongo
from datetime import datetime


app = Flask(__name__)

#
MONGODB_URI='mongodb+srv://asabeneh:your_password@30daysofpython-twxkr.mongodb.net/test?retryWrites=true&w=majority'
client = pymongo.MongoClient(MONGODB_URI)
db = client['thirty_days_of_python'] # accessing the database

@app.route('/api/v1.0/students', methods = ['GET'])
def students ():

    return Response(json.dumps(student), mimetype='application/json')
@app.route('/api/v1.0/students/<id>', methods = ['GET'])
def single_student (id):
    student = db.students.find({'_id':ObjectId(id)})
    return Response(dumps(student), mimetype='application/json')
@app.route('/api/v1.0/students', methods = ['POST'])
def create_student ():
    name = request.form['name']
    country = request.form['country']
    city = request.form['city']
    skills = request.form['skills'].split(', ')
    bio = request.form['bio']
    birthyear = request.form['birthyear']
    created_at = datetime.now()
    student = {
        'name': name,
        'country': country,
        'city': city,
        'birthyear': birthyear,
        'skills': skills,
        'bio': bio,
        'created_at': created_at

    }
    db.students.insert_one(student)
    return
@app.route('/api/v1.0/students/<id>', methods = ['PUT']) # this decorator create the home route
def update_student (id):
    query = {"_id":ObjectId(id)}
    name = request.form['name']
    country = request.form['country']
    city = request.form['city']
    skills = request.form['skills'].split(', ')
    bio = request.form['bio']
    birthyear = request.form['birthyear']
    created_at = datetime.now()
    student = {
        'name': name,
        'country': country,
        'city': city,
        'birthyear': birthyear,
        'skills': skills,
        'bio': bio,
        'created_at': created_at

    }
    db.students.update_one(query, student)
    # return Response(dumps({"result":"a new student has been created"}), mimetype='application/json')
    return
def update_student (id):
if __name__ == '__main__':
    # for deployment
    # to make it work for both production and development
    port = int(os.environ.get("PORT", 5000))
    app.run(debug=True, host='0.0.0.0', port=port)

使用 Delete 删除文档

# let's import the flask

from flask import Flask,  Response
import json
from bson.objectid import ObjectId
import json
from bson.json_util import dumps
import pymongo
from datetime import datetime


app = Flask(__name__)

#
MONGODB_URI='mongodb+srv://asabeneh:your_password@30daysofpython-twxkr.mongodb.net/test?retryWrites=true&w=majority'
client = pymongo.MongoClient(MONGODB_URI)
db = client['thirty_days_of_python'] # accessing the database

@app.route('/api/v1.0/students', methods = ['GET'])
def students ():

    return Response(json.dumps(student), mimetype='application/json')
@app.route('/api/v1.0/students/<id>', methods = ['GET'])
def single_student (id):
    student = db.students.find({'_id':ObjectId(id)})
    return Response(dumps(student), mimetype='application/json')
@app.route('/api/v1.0/students', methods = ['POST'])
def create_student ():
    name = request.form['name']
    country = request.form['country']
    city = request.form['city']
    skills = request.form['skills'].split(', ')
    bio = request.form['bio']
    birthyear = request.form['birthyear']
    created_at = datetime.now()
    student = {
        'name': name,
        'country': country,
        'city': city,
        'birthyear': birthyear,
        'skills': skills,
        'bio': bio,
        'created_at': created_at

    }
    db.students.insert_one(student)
    return
@app.route('/api/v1.0/students/<id>', methods = ['PUT']) # this decorator create the home route
def update_student (id):
    query = {"_id":ObjectId(id)}
    name = request.form['name']
    country = request.form['country']
    city = request.form['city']
    skills = request.form['skills'].split(', ')
    bio = request.form['bio']
    birthyear = request.form['birthyear']
    created_at = datetime.now()
    student = {
        'name': name,
        'country': country,
        'city': city,
        'birthyear': birthyear,
        'skills': skills,
        'bio': bio,
        'created_at': created_at

    }
    db.students.update_one(query, student)
    # return Response(dumps({"result":"a new student has been created"}), mimetype='application/json')
    return
@app.route('/api/v1.0/students/<id>', methods = ['PUT']) # this decorator create the home route
def update_student (id):
    query = {"_id":ObjectId(id)}
    name = request.form['name']
    country = request.form['country']
    city = request.form['city']
    skills = request.form['skills'].split(', ')
    bio = request.form['bio']
    birthyear = request.form['birthyear']
    created_at = datetime.now()
    student = {
        'name': name,
        'country': country,
        'city': city,
        'birthyear': birthyear,
        'skills': skills,
        'bio': bio,
        'created_at': created_at

    }
    db.students.update_one(query, student)
    # return Response(dumps({"result":"a new student has been created"}), mimetype='application/json')
    return ;
@app.route('/api/v1.0/students/<id>', methods = ['DELETE'])
def delete_student (id):
    db.students.delete_one({"_id":ObjectId(id)})
    return
if __name__ == '__main__':
    # for deployment
    # to make it work for both production and development
    port = int(os.environ.get("PORT", 5000))
    app.run(debug=True, host='0.0.0.0', port=port)

<< 第 28 天 || 第 30 天 >>

舍不得，放不下
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
API接口开发其实特简单，Python Flask Web 框架教程来了
Python学习与数据挖掘
10-03 7545
大家好，日常工作中，无论你是数据工程师、数据挖掘工程师，甚至数据分析人员，都不可避免的与他人进行数据交互，API接口提供数据是最常见的形式。今天我给大家分享 Python Flask Web 框架教程，共计10个部分，后续内容会更新，
python怎么用api_用Python创建API的正确方法
weixin_39682477的博客
12-14 1006
用Python创建API的正确方法Python3最后更新 2020-09-27 14:21阅读 4657最后更新 2020-09-27 14:21阅读 4657Python3##FlyAI文献翻译**英文原文：**[：The Right Way to Build an API with Python](https://towardsdatascience.com/the-right-way-to-...
python 创建api
weixin_42613360的博客
01-16 334
在 Python 中可以使用很多第三方框架来创建 API，常见的有 Flask、Django、FastAPI 等。 Flask 是一个轻量级的框架，可以快速构建小型 API。示例代码如下： from flask import Flask, jsonify app = Flask(__name__) @app.route('/') def hello(): return jsonify(...
Python微服务开发，构建高效API
alafaqi的博客
07-03 429
FastAPI 是一个现代、高性能的 Python Web 框架，专为构建 API 而设计。总之，FastAPI 提供了一种快速、高效地构建和部署 Python 微服务的方法。通过掌握其核心概念和功能，可以大幅提高 API 开发的效率。微服务架构在现代软件开发中日益普及，它将复杂的应用程序拆分成多个可独立部署的小型服务。要使用 FastAPI，首先需要安装它及其依赖。FastAPI 自动生成交互式 API 文档，可以通过访。此外，还可以使用 FastAPI 的。来查看 API 的响应。进行 API 测试。
如何用Python开发API
An4480的博客
12-22 1107
在Python中，一个API由多个端点组成。每个端点都对应于一个URL以及HTTP方法（GET、POST、PUT等）。定义好端点之后，在代码中就可以通过API调用来获取特定的数据或执行特定的操作。
从模型到部署，教你如何用Python构建机器学习API服务
华为云官方博客
04-08 1319
本文将介绍如何使用Python构建机器学习模型的API服务，并提供案例代码作为示例。
atlassian-python-api：Atlassian Python REST API包装器
02-05
【atlassian-python-api】是一个专为Python开发者设计的库，它提供了一个简洁的接口来与Atlassian产品（如Jira、Confluence、Bamboo、Bitbucket、Crowd、Tempo和Xray等）的REST API进行交互。这个API包装器使得与...
wp-api-python：WooCommerce API的Python包装器
02-05
通过`wp-api-python`，Python开发者可以轻松地集成WooCommerce功能到他们的应用中，实现自动化任务，或者构建与WooCommerce商店交互的定制解决方案。这个库极大地简化了与REST API的交互，使得处理电子商务数据变得...
python-cryptowatch：Cryptowatch公共API Python实现
02-05
**Python-Cryptowatch 公共API实现** Python-Cryptowatch 是一个Python库，用于与Cryptowatch的公共API接口进行交互。Cryptowatch是一个实时加密货币市场数据平台，提供丰富的交易信息，如市场价格、交易量、图表和...
confluence-python-lib：包装Confluence REST API的python库
02-05
《使用confluence-python-lib库与Confluence REST API交互》 在现代企业中，Confluence作为一个强大的协作和知识管理平台，被广泛应用于文档共享、团队协作和项目管理。为了方便Python开发者与Confluence进行高效的...
Python搭建的web接口聊天机器人
01-25
用Python搭建的聊天机器人，接口为web形式，运行后可以直接通过url与机器人聊天,url地址为http://localhost/aiml?req=hello（这里hello即为发送给机器人的信息）。用到了aiml开源库。
Python-Arduino-Proto-API-v2:一个 Python-Arduino-Prototyping-API 分支变得疯狂
06-07
Python Arduino Prototyping API 可帮助您快速构建 Arduino 程序的原型，而无需重复将程序加载到 Arduino 板。 设置： 将prototype.pde 加载到您的Arduino 开发板上。 在您的 python 脚本中导入 arduino 库。 方法...
Python实现比REST快10倍的用构建API的方法
Mr数据杨
03-07 9759
很多用Python开发API接口经常会用到。但是还有一种更适合初学者并且速度更快的创建API方法，就是。FastAPI 是一个现代、快速（高性能）的 Web 框架，用于基于 Python 的标准类型提示在 Python 3.6 及更高版本中构建 API。FastAPI 能够自动生成 Swagger UI 和 ReDoc 样式文档。
API接口开发其实特简单，Python FastApi Web 框架教程来了
Python学习与数据挖掘
10-06 5681
API接口开发其实特简单，Python FastApi Web 框架教程来了
深度学习模型最佳部署方式：用Python实现HTTP服务器作API接口
01-21 6946
在苹果系统下，如果文章中的图片不能正常显示，请升级Safari浏览器到最新版本，或者使用Chrome、Firefox浏览器打开。) 当训练和测试完成一个深度学习模型之后，如果我们打算将这个算法模型上线，投入生产环境部署使用，那么我们就需要做一些额外的处理工作。由于深度学习模型对于算力需求较大，在上线过程中，一般有减小网络规模、使用专用硬件和通过C/S架构联网进行云端计算这三种方式。AI柠檬博主推荐使用第三种方式，即模型部署于服务器端，客户端通过网络将输入数据发送至服务器，计算得结果后传递给客户端。...
Python | 使用Flask搭建一个API服务器
Mculover666的博客（嵌入式）
05-26 2772
一、API列表 1. 获取作品列表 ① 获取手工制作作品列表。 请求格式： http://api.mculover666.cn:9999/twkk/list/hand_made 返回结果： { goods_num: 3, goods_item: [ { goods_id: 1, goods_name: "goods1", goods_img_url: "xxx" }, { goods_id: 2, goods_name: "goods1", goods_
Python3，网站搭建之编写API接口，让前端页面展示数据！
热门推荐
商务合作 | 面试培训 | 职场规划 ==>主页扫码
09-09 1万+
小屌丝：小鱼哥，你这周干啥了？ 一周没更新博文了 小鱼：嗯，确实时间过得很快，这一周，我在忙乎一件大事啊！ 小屌丝好奇了：挖草~~ 鱼哥，借一步说话，啥事情啊，能让你这么忙活？？ 小鱼：这… 休想用一顿烧烤贿赂我… 小屌丝：赶紧的吧，鱼哥，两顿，连吃带拿的那种，行不？ 小鱼：嗯… 行吧，透露一点点，跟银子有关… 小屌丝：啥啊，再具体点？？ 小鱼：哈哈，你这句 “再具体点”，让我想起了曾经一个面试官，可能是能力有限，亦或者是… 在面试的时候，说的就差直接把代码+标注 写在纸上了，然鹅，那位面试官还是说，再
python + requests实现的电商API接口自动化框架详细教程
电商数据Girl的博客
07-25 594
没错，因为前面我们写了config.ini文件，所有的数据库配置信息都在这个文件内哦，是不是感觉很方便呢，以后就算变更数据库了，也只要修改config.ini文件的内容就可以了，结合前面测试用例的管理（excel文件），sql语句的存放（xml文件），还有接下来我们要说的，businessCommon.py和存放具体case的文件夹，那么我们就已经将数据和业务分开啦，哈哈哈，想想以后修改测试用例内容，sql语句神马的工作，再也不用每个case都修改，只要改几个固定的文件，是不是顿时开心了呢？
Flask 处理响应
最新发布
CSDN全栈领域优秀博主，阿里云博客专家，工信部权威认证物联网技术开发工程师，曾30分钟高分通过C语言二级，两天手撸代码完成EasyX飞机大战，靠接软件私活一个月换苹果电脑
08-05 167
Flask 允许你完全控制响应对象，包括状态码、头部信息和响应体。这可以通过创建并返回一个Response对象来实现。
掌握TensorFlow Python API：构建与操作指南
TensorFlow Python API文档是Google开发的深度学习库TensorFlow的核心组成部分，提供了丰富的工具和功能来构建、管理和执行计算图。这个文档详细介绍了如何在Python环境中利用TensorFlow进行高效的数据处理、模型...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

舍不得，放不下

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值