挑战30天学完Python：Day29 API开发

2024-03-01 10:20
文章标签 python 开发 api 30 挑战 day29 天学

本文主要是介绍挑战30天学完Python：Day29 API开发，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

🎉 本系列为Python基础学习，原稿来源于 30-Days-Of-Python 英文项目，大奇主要是对其本地化翻译、逐条验证和补充，想通过30天完成正儿八经的系统化实践。此系列适合零基础同学，或仅了解Python一点知识，但又没有系统学习的使用者。总之如果你想提升自己的Python技能，欢迎加入《挑战30天学完Python》

  • Day 29
  • API基础
    • HTTP
      • 请求头行
      • 响应头行
      • 头字段
      • 消息体
      • 请求方法
    • 构建API
      • 使用GET检索数据
      • 通过id获取学生详细
      • 使用POST创建数据
      • 使用PUT更新数据
      • 使用DELETE删除数据
  • 💻 第29天练习

📘 Day 29

API基础

英文全称 Application Programming Interface。在这个时代，大多数应用程序都需要使用 API（应用程序编程接口）来与其他应用程序或服务进行通信。

API是一种允许应用程序之间交互的方式。在互联网上，我们经常使用API从其他应用程序或服务中获取数据或执行某些操作。API允许我们从远程服务器获取数据，而不需要自己存储或管理数据。

例如，您可能会使用天气应用程序获取当地天气预报。该应用程序不会自己生成天气数据，而是使用第三方服务的API获取数据。这个API可能允许应用程序查询天气预报，然后将数据返回给应用程序。

API通常使用REST（Representational State Transfer）协议进行通信，该协议使用HTTP请求和响应来获取和返回数据。我们可以使用Python的requests库来发送HTTP请求，然后使用json模块解析响应。

在本小节中，我们将介绍一个RESTful API，它使用HTTP请求方法来GET、PUT、POST和DELETE数据。

HTTP

HTTP(Hypertext Transfer Protocol)超文本传输协，是客户端和服务器之间已经确立的通信协议。在这种情况下，客户端是浏览器，而服务器是访问数据的地方。HTTP是一种网络协议，用于传输资源，这些资源可以是世界范围内网站上的文件，无论它们是HTML文件、图像文件、查询结果、脚本或其他文件类型。

浏览器是HTTP客户端，因为它向HTTP服务器（Web服务器）发送请求，服务器然后将响应发送回客户端。

HTTP采用客户端-服务器模型。HTTP客户端打开连接并向HTTP服务器发送请求消息，HTTP服务器返回请求的资源响应消息。当请求-响应周期完成时，服务器关闭连接。

在这里插入图片描述

请求和响应消息的格式类似。这两种信息都有

  • 一个初始行，
  • 零个或多个头部行，
  • 一个空行（即一个独立的CRLF），
  • 一个可选的消息体（例如一个文件，或查询数据，或查询输出）。

让我们启动Day26时候我们写的一个web程序并请求其中一个接口，打开浏览器开发者工具查看下网络栏里接口信息。

在这里插入图片描述

注意：如果浏览器请求的信息和上方不太一样，可以看看是否有箭头处切换“源码(view source)”文本按钮，如果进行切换。否则默认优化过的显示。

请求头行

初始请求行与响应行不同。

请求行有三部分，用空格分隔:

  • 方法名 (GET, POST, HEAD)
  • 被请求资源的路径
  • 使用的HTTP版本 eg: GET / HTTP/1.1

方法中 GET是最常用的帮助获取或读取资源的, POST是创建资源的常用请求方法。

响应头行

初始响应行返回部分，也有由空格分隔的三部分：

  • HTTP 版本
  • 请求响应状态码，以及描述状态码的原因。状态行示例如下:
  HTTP/1.0 200 OK或HTTP/1.0 404 Not Found

最常见的状态码有:

  • 200 OK：请求成功，结果资源(例如文件或脚本输出)在消息体中返回。
  • 500 Server Error：服务器错误

HTTP状态码的完整列表可以在这里(https://httpstatuses.com/)找到。

头字段

正如您在上面的请求返回截图中所看到的，标题行提供了关于请求或响应或者关于消息体中发送的对象的更多信息。

# 请求信息
GET /about HTTP/1.1
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7
Accept-Encoding: gzip, deflate, br
Accept-Language: zh-CN,zh;q=0.9,en;q=0.8,en-GB;q=0.7,en-US;q=0.6
Connection: keep-alive
Host: 127.0.0.1:5000
Sec-Fetch-Dest: document
Sec-Fetch-Mode: navigate
Sec-Fetch-Site: none
Sec-Fetch-User: ?1
Upgrade-Insecure-Requests: 1
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36 Edg/111.0.1661.62
sec-ch-ua: "Microsoft Edge";v="111", "Not(A:Brand";v="8", "Chromium";v="111"
sec-ch-ua-mobile: ?0
sec-ch-ua-platform: "Windows"# 响应信息
HTTP/1.1 200 OK
Server: Werkzeug/2.2.3 Python/3.8.10
Date: Wed, 05 Apr 2023 04:58:31 GMT
Content-Type: text/html; charset=utf-8
Content-Length: 1316
Connection: close
消息体

HTTP消息可以在头部行之后包含一段数据主体。在响应中，这是请求的资源返回给客户端的位置（消息主体最常见的用法），或者在出现错误时提供解释性的文本。在请求中，这是用户输入的数据或上传的文件发送到服务器的位置。

如果HTTP消息包含消息主体，则通常会有描述消息主体的头部行。特别是：

  • Content-Type：头部行给出了消息主体中数据的MIME类型（text/html，application/json，text/plain，text/css，image/gif）。
  • Content-Length：头部行给出了消息主体中字节数的数量。
请求方法

GET、POST、PUT 和 DELETE 是HTTP请求方法，我们可以用它们来实现API或CRUD操作应用程序。

  1. GET：GET方法用于通过给定的URI从给定的服务器检索和获取信息。使用GET的请求应该只检索数据，并且不应对数据产生其他影响。
  2. POST：POST请求用于创建数据并将数据发送到服务器，例如，使用HTML表单创建新的帖子、文件上传等。
  3. PUT：将上传的内容替换目标资源的所有当前表示，并使用它来修改或更新数据。
  4. DELETE：删除数据。

构建API

在这一部分，我们将介绍一个使用HTTP请求方法来获取(GET)、更新(PUT)、创建(POST)和删除(DELETE)数据的RESTful API。

RESTful API是一个应用程序接口(API)，它使用HTTP请求来获取、更新、创建和删除数据。在之前的章节中，我们学习了Python、Flask和MongoDB。我们将利用所学知识来开发一个使用Python Flask和MongoDB的RESTful API。每个具有CRUD（创建、读取、更新、删除）操作的应用程序都有一个API，用于从数据库中创建数据、获取数据、更新数据或删除数据。

浏览器只能处理GET请求。因此，我们需要一个工具来处理所有请求方法（GET、POST、PUT、DELETE）。

这里先提一款接口流程测试工具叫 Postman，后边的内容我们将使用它进行演示。如果你的电脑上没有，请先到 https://www.getpostman.com 官方下载安装。

在这里插入图片描述

接下来，让我们综合之前所学的内容，开发一个关于学生信息的管理服务API。此信息存储在mongodb中包含：姓名, 国家, 城市, 生日, 技能 和 简历.

要实现这个API，我们将使用：

  • Postman
  • Python
  • Flask
  • MongoDB

使用GET检索数据

在这一步中，让我们使用虚拟数据并将其作为JSON返回。为了将其作为JSON返回，我们将使用json模块和Response模块。

from flask import Flask, Response
import os
import jsonapp = Flask(__name__)@app.route('/api/v1.0/students', methods = ['GET'])
def students ():student_list = [{'name':'MegaQi','country':'China','city':'ShangHai','skills':['JAVA', 'VUE','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__':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 后你将得到如下结果：

在这里插入图片描述

你也可通过pastman工具进行请求 http://localhost:5000/api/v1.0/students 它将得到同样的返回结果：

在这里插入图片描述

让我们进一步优化程序，将Mock的数据改为MongoDB获取。

from flask import Flask, Response
from bson import json_util
import pymongo
import os
import jsonapp = Flask(__name__)MONGODB_URI = "mongodb://localhost:27017/"
client = pymongo.MongoClient(MONGODB_URI)
db = client['thirty_days_of_python']@app.route('/api/v1.0/students', methods = ['GET'])
def students ():student_list = db.students.find() # 查询所有学生# 请注意此处使用一个json_util转换而非json，否则mongo查询所有字段所带_id会报错# return Response(json.dumps(student_list), mimetype='application/json')return Response(json_util.dumps(student_list), mimetype='application/json') if __name__ == '__main__':port = int(os.environ.get("PORT", 5000))app.run(debug=True, host='0.0.0.0', port=port)

如果之前的练习中你已经将学生数据删除了，请提前重新添加一些。再次通过postman请求数据你将得到从数据库查询的学生列表。

[{"_id": {"$oid": "642d17760e244123faad21ee"},"name": "David","country": "UK","city": "London","age": 34},{"_id": {"$oid": "642d17760e244123faad21ef"},"name": "John","country": "Sweden","city": "Stockholm","age": 28},{"_id": {"$oid": "642d17760e244123faad21f0"},"name": "MegaQi","country": "China","city": "ShangHai","age": 25},{"_id": {"$oid": "642d17760e244123faad21f1"},"name": "Sami","country": "Finland","city": "Helsinki","age": 25},{"_id": {"$oid": "642d17760e244123faad21f2"},"name": "Tom","country": "Kroen","city": "Seoul","age": 26}
]

通过id获取学生详细

我们可以使用id访问单个文档，即写一个根据条件获取一名学生的详细信息。
http://localhost:5000/api/v1.0/students/<_id>

from flask import Flask, Response
from bson import json_util, ObjectId
import pymongo
import os
import jsonapp = Flask(__name__)MONGODB_URI = "mongodb://localhost:27017/"
client = pymongo.MongoClient(MONGODB_URI)
db = client['thirty_days_of_python']@app.route('/api/v1.0/students', methods = ['GET'])
def students ():student_list = db.students.find() # 查询所有学生# 请注意此处使用一个json_util转换而非json，否则mongo查询所有字段所带_id会报错# return Response(json.dumps(student_list), mimetype='application/json')return Response(json_util.dumps(student_list), 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(json_util.dumps(student), mimetype='application/json')if __name__ == '__main__':port = int(os.environ.get("PORT", 5000))app.run(debug=True, host='0.0.0.0', port=port)

请求新增根据ID的查询结果如下（注意ID信息根据你自己的数据进行替换）：

在这里插入图片描述

使用POST创建数据

我们使用POST请求方法创建学生数据

@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 "create successful"

请求测试，为了更准确验证，一般还要在数据库确认是否正确落库。

在这里插入图片描述

使用PUT更新数据

@app.route('/api/v1.0/students/<id>', methods = ['PUT'])
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 ={'$set': {'name': name,'country': country,'city': city,'birthyear': birthyear,'skills': skills,'bio': bio,'created_at': created_at}}db.students.update_one(query, student)return "update successful"

在代码编写上述更新接口，并重启程序进行请求测试

在这里插入图片描述

最后在数据中查看下刚才增改两个操作是否正确

在这里插入图片描述

使用DELETE删除数据

@app.route('/api/v1.0/students/<id>', methods = ['DELETE'])
def delete_student (id):db.students.delete_one({"_id":ObjectId(id)})return "delete successful"

在本次数据演示中我们删除一条名叫 David 学生数据。

在这里插入图片描述

以上第二小部分内容中，我们实现了一个标准 RESTful 风格的API程序。在平常工作中可能大家见到的接口基本都是GET/POST两种，研发通过接口名区分其他操作，而不是用这种请求方法。

💻 第29天练习

  1. 阅读和了解 HTTP / RESTful API 基础知识的内容
  2. 参照学生学生管理操作，请写一些员工管理接口。

🎉 CONGRATULATIONS ! 🎉

这篇关于挑战30天学完Python：Day29 API开发的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/762118。

相关文章

Java调用DeepSeek API的最佳实践及详细代码示例

Java调用DeepSeek API的最佳实践及详细代码示例

《Java调用DeepSeekAPI的最佳实践及详细代码示例》：本文主要介绍如何使用Java调用DeepSeekAPI,包括获取API密钥、添加HTTP客户端依赖、创建HTTP请求、处理响应、... 目录1. 获取API密钥2. 添加HTTP客户端依赖3. 创建HTTP请求4. 处理响应5. 错误处理6.
阅读更多...
python使用fastapi实现多语言国际化的操作指南

python使用fastapi实现多语言国际化的操作指南

《python使用fastapi实现多语言国际化的操作指南》本文介绍了使用Python和FastAPI实现多语言国际化的操作指南,包括多语言架构技术栈、翻译管理、前端本地化、语言切换机制以及常见陷阱和... 目录多语言国际化实现指南项目多语言架构技术栈目录结构翻译工作流1. 翻译数据存储2. 翻译生成脚本
阅读更多...
Android 悬浮窗开发示例((动态权限请求 | 前台服务和通知 | 悬浮窗创建 )

Android 悬浮窗开发示例((动态权限请求 | 前台服务和通知 | 悬浮窗创建 )

《Android悬浮窗开发示例((动态权限请求|前台服务和通知|悬浮窗创建)》本文介绍了Android悬浮窗的实现效果,包括动态权限请求、前台服务和通知的使用,悬浮窗权限需要动态申请并引导... 目录一、悬浮窗 动态权限请求1、动态请求权限2、悬浮窗权限说明3、检查动态权限4、申请动态权限5、权限设置完毕后
阅读更多...
如何通过Python实现一个消息队列

如何通过Python实现一个消息队列

《如何通过Python实现一个消息队列》这篇文章主要为大家详细介绍了如何通过Python实现一个简单的消息队列,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录如何通过 python 实现消息队列如何把 http 请求放在队列中执行1. 使用 queue.Queue 和 reque
阅读更多...
Python如何实现PDF隐私信息检测

Python如何实现PDF隐私信息检测

《Python如何实现PDF隐私信息检测》随着越来越多的个人信息以电子形式存储和传输,确保这些信息的安全至关重要,本文将介绍如何使用Python检测PDF文件中的隐私信息,需要的可以参考下... 目录项目背景技术栈代码解析功能说明运行结php果在当今，数据隐私保护变得尤为重要。随着越来越多的个人信息以电子形
阅读更多...
使用Python快速实现链接转word文档

使用Python快速实现链接转word文档

《使用Python快速实现链接转word文档》这篇文章主要为大家详细介绍了如何使用Python快速实现链接转word文档功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 演示代码展示from newspaper import Articlefrom docx import
阅读更多...
Python Jupyter Notebook导包报错问题及解决

Python Jupyter Notebook导包报错问题及解决

《PythonJupyterNotebook导包报错问题及解决》在conda环境中安装包后,JupyterNotebook导入时出现ImportError,可能是由于包版本不对应或版本太高,解决方... 目录问题解决方法重新安装Jupyter NoteBook 更改Kernel总结问题在conda上安装了
阅读更多...
Python如何计算两个不同类型列表的相似度

Python如何计算两个不同类型列表的相似度

《Python如何计算两个不同类型列表的相似度》在编程中,经常需要比较两个列表的相似度,尤其是当这两个列表包含不同类型的元素时,下面小编就来讲讲如何使用Python计算两个不同类型列表的相似度吧... 目录摘要引言数字类型相似度欧几里得距离曼哈顿距离字符串类型相似度Levenshtein距离Jaccard相
阅读更多...
Python安装时常见报错以及解决方案

Python安装时常见报错以及解决方案

《Python安装时常见报错以及解决方案》：本文主要介绍在安装Python、配置环境变量、使用pip以及运行Python脚本时常见的错误及其解决方案,文中介绍的非常详细,需要的朋友可以参考下... 目录一、安装 python 时常见报错及解决方案（一）安装包下载失败（二）权限不足二、配置环境变量时常见报错及
阅读更多...
Python中顺序结构和循环结构示例代码

Python中顺序结构和循环结构示例代码

《Python中顺序结构和循环结构示例代码》：本文主要介绍Python中的条件语句和循环语句,条件语句用于根据条件执行不同的代码块,循环语句用于重复执行一段代码,文章还详细说明了range函数的使... 目录一、条件语句（1）条件语句的定义（2）条件语句的语法（a）单分支 if（b）双分支 if-else（
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2