Apprenez-vous un truc ! Créez une API REST avec Python et Flask !

Introduction à l'API REST

Notez qu'il ne s'agit que d'une brève introduction à l'API REST, qui sert de point de départ. Un contenu plus approfondi n'entre pas dans le cadre de cette étude. consultez les documents pertinents pour une étude approfondie. De plus, ce compte accepte les soumissions dans ce domaine, veuillez contacter Yun Duojun !

API

API, le nom complet est Application Programming Interface (Application Programming Interface). En termes simples, il s'agit d'une interface développée par la marque qui permet à des tiers de développer et d'appliquer en outre une communication système à leurs propres produits. interface.

API REST

REST est un style architectural permettant de concevoir des API via le protocole HTTP. Son principal avantage est sa grande flexibilité. Les développeurs utilisent les API REST chaque fois qu'ils ont besoin de fournir des données directement depuis le serveur aux utilisateurs d'une application ou d'un site Web.

Principaux composants de l'API REST :

• Client — Un client ou un programme lancé du côté de l'utilisateur (sur son appareil) qui initie la communication.
• Serveur — Un serveur qui utilise des API pour accéder à ses fonctionnalités et à ses données.
• Ressource — Tout contenu (vidéo, texte, image) transmis par le serveur au client.

L'API REST communique via des requêtes HTTP pour remplir les fonctions suivantes : créer, lire, mettre à jour et supprimer des données. Elles sont également appelées opérations CRUD. REST fournit des informations sur la ressource demandée et utilise quatre méthodes pour décrire comment gérer la ressource :

• POST — crée la ressource ;
• GET — récupère la ressource
• PUT — met à jour la ressource ; ressource.
• API RESTful

REST, le nom complet est Representational State Transfer (transfert d'état de couche de présentation), c'est un style de conception, RESTful est simplement converti en adjectif, comme le nom paix, converti en adjectif est paisible, RESTful est une description. Les API conçues selon cette spécification sont appelées API RESTful.

L'API RESTful est principalement composée de trois composants :

Noms : URL qui définit l'emplacement d'une ressource Chaque ressource aura un emplacement unique sur le réseau, tout comme chaque maison a une adresse unique.

• Verbes : Actions à effectuer sur les ressources.
• Types de contenu Méthode de présentation des ressources : les ressources API peuvent être présentées de différentes manières, la plus couramment utilisée est JSON, qui est léger et facile à traiter.
• Ainsi, l'utilisation d'une API conçue dans le style RESTful présente les avantages et les limites suivants :

Il existe une URL unique indiquant l'emplacement de la ressource et une interface API unifiée. (Interface uniforme)

1. Apatride. (Apatride)
2. API Restful Elle permet d'intégrer des applications d'application ou d'interagir avec les services Web Restful. Elle devient désormais la méthode la plus courante de connexion de composants dans l’architecture de microservices. À l'aide d'API, nous sommes en mesure d'obtenir ou d'envoyer des données au site Web et d'effectuer certaines opérations dans le but d'accomplir nos tâches via des services Web. Chaque site Web utilise différents types d'API, comme les sites Web de négociation boursière, à l'aide d'API, ils obtiennent les prix actuels et les fluctuations à la hausse et à la baisse.

Créez la première API REST

De même, nous créons l'API Hello world, ce qui signifie que si vous lui faites une requête get, vous obtiendrez une réponse JSON. Généralement, l'API donne une réponse de type JSON. Ensuite, utilisez le gestionnaire de packages pip pour installer Flask :

pip install flask
pip install flask-restful
from flask import Flask
from flask_restful import Resource, Api
app = Flask(__name__)
api = Api(app)
class Helloworld(Resource):
 def __init__(self):
 pass
 def get(self):
 return {
 "Hello": "World"
 }
api.add_resource(Helloworld, '/')
if __name__ == '__main__':
app.run(debug=True)

ok Jusqu'à présent, la première API Rest a été créée. Alors, qu'est-ce que Flask-Restful ?

Flask restful définit la classe Resource, qui contient des méthodes pour chaque méthode HTTP. Le nom de la méthode doit être le même que sa méthode HTTP correspondante et écrit en minuscules, comme indiqué dans le code ci-dessus. Nous avons constaté que ces méthodes ne disposent pas de décorateurs de route, car elles sont basées sur le routage des ressources. Quelle que soit la classe définie, nous pouvons utiliser la méthode add_resource pour définir une route vers celle-ci et appeler la classe sur la route correspondante.

Remarque : dans le code ci-dessus, nous chargeons d'abord la classe parent requise, puis initialisons notre application et notre API. Après cela, nous avons créé un programme et nous faisons une requête GET indiquant que si quelqu'un clique sur ce programme, il obtiendra Hello world en réponse au format JSON. Pour ouvrir une URL spécifique, nous utilisons la méthode d'ajout de ressource et la dirigeons vers la barre oblique par défaut. Pour exécuter ce fichier, vous pouvez utiliser l'outil POSTMAN, un outil de maintenance d'API pour créer, tester et gérer des API. Vous pouvez également utiliser le module de requêtes pour tester cette API à l'aide du code suivant. Tout d’abord, exécutez le fichier ci-dessus et il vous donnera l’URL localhost, puis dans une autre invite de commande, exécutez le fichier de code suivant :

import requests
url = "http://127.0.0.1:5000/"
response = requests.get(url=url)
print(response.text)
{
"Hello": "World"
}

通过 Flask RESTApi 理解 HTTP 请求

通过以上内容的学习，相比大家已经对 REST API 有个初步印象。接下来我们将继续探索使用 REST API 的不同 HTTP 方法，其中我们定义一个列表，该列表将以字典（JSON 对象）的形式存储从服务器获取的所有数据。这是很重要的，因为我们在项目中有不同的api来获取数据，而不是其他地方的数据。

首先创建一个 API，在其中创建 3 个名为 GET、POST 和 DELETE 的 HTTP 方法，并且在其中创建一个自定义 URL，当请求 POST 方法时，它将以 Name 作为输入；在请求 GET 方法时，将名称返回；在DELETE时，如果该名称存在，我们将删除该名称，再次访问它会给我们 NULL。

创建一个文件并编写以下代码：

from flask import Flask
from flask_restful import Resource, Api
app = Flask(__name__)
api = Api(app)
data = []
class People(Resource):
def get(self):
 for x in data:
 if x['Data'] == name:
 return x
 return {'Data': None}
def post(self, name):
 temp = {'Data': name}
 data.append(temp)
 return temp
def delete(self):
 for ind, x in enumerate(data):
if x['Data'] == name:
temp = data.pop(ind)
return {'Note': 'Deleted'}
api.add_resource(People, '/Name/')
if __name__ == '__main__':
app.run(debug=True)

打开 POSTMAN API 工具并点击每个 HTTP 方法请求。首先，当我们使用 post 请求Name时，它给了我们一个name。在获取请求时，我们将返回name。它在删除时被删除，当再次将其取回时，它会给你返回 NULL。

结果如下

如何在 Flask REST API 中使用装饰器

我们使用带有 API 的装饰器来监控 IP 地址、cookie 等。我们将继续学习如何使用带有装饰器的Flask API。装饰器是一个将另一个函数作为参数并返回另一个函数的函数。也可以将其理解为在不改变或修改当前功能的情况下，为现有功能提供一些附加功能的功能。

这里我们创建一个新文件，我将通过创建两个装饰器来展示。在第一个文件中，编写返回代码执行时间的外部时间函数。我们从 functools 模块（用于高阶 python 函数的标准模块）导入应用于 wrapper 函数的 wrap 装饰器 。它通过复制所有参数来更新包装函数。

from flask import Flask
from flask_restful import Resource, Api
import datetime
from flask import request
from functools import wraps
app = Flask(__name__)
api = Api(app)
def time(function=None):
 @wraps(function)
 def wrapper(*args, **kwargs):
 s = datetime.datetime.now()
 _ = function(*args, **kwargs)
 e = datetime.datetime.now()
 print("Execution Time : {} ".format(e-s))
 return _
 return wrapper
class HelloWorld(Resource):
 @monitor
 def get(self):
 return {"hello": "world"}
api.add_resource(HelloWorld, "/")
if __name__ == "__main__":
 app.run(debug=True)

我们创建第二个装饰器来监视cookie和IP地址，因此创建下面的函数。不是向hello world函数添加时间装饰器，而是添加监视器装饰器并运行代码。

def monitor(function=None):
 @wraps(function)
 def wrapper(*args, **kwargs):
 _ = function(*args, **kwargs)
 print("Ip Address: {} ".format(request.remote_user))
 print("Cookies : {} ".format(request.cookies))
 print(request.user_agent)
 return _
 return wrapper

如何使 Flask API 更安全

当我们设计API时，我们也应该注意安全性，因为很多人会访问它。因为API可能包含一些双方之间的机密数据，因此我们可以指定只有授权的人可以访问API，那该怎么办？此时可以使用Flask基本身份验证。当然，此时需要使用pip命令安装这个flask模块。

pip install flask-httpauth

我们正在构建一个API并定义User数据字典，其中包含用户名和密码。当在实时用例中工作时，可以通过配置文件或从数据库中接受用户名和密码。首先，我们创建一个主要函数来匹配用户名和密码，并创建一个GET方法，该方法表示任何点击此API的人，如果没有登录，我们就无法访问数据。

from flask import Flask
from flask_restful import Resource, Api
from flask_httpauth import HTTPBasicAuth
app = Flask(__name__)
api = Api(app, prefix="/api/v1")
auth = HTTPBasicAuth()
USER_DATA = {
"admin": "SuperSecretPwd"
}
#route to verify the password
@auth.verify_password
def verify(username, password):
if not(username and password):
 return False
return USER_DATA.get(username) == password
class PrivateResource(Resource):
@auth.login_required
def get(self):
 return {"How's the Josh": "High"}
api.add_resource(PrivateResource, '/private')
if __name__ == '__main__':
app.run(debug=True)

当我们使用POSTMAN运行上述文件时，我们会尝试在没有登录的情况下获取数据，以便给你演示未经授权的访问权限。

现在转到授权，并单击Basic authorization。输入用户名和密码，然后点击GET请求以获得所需的结果。

这是保护 Flask API 的方法，也是最基本的方法，当然还有更多更高级的方法，这里不做过多的介绍。

如何在 Flask API 上启用跟踪

至此我们已经了解了如何保护我们的 API，在未经授权的登录禁止访问，但是如果我们还想知道访问者的位置（纬度和经度点）、IP 地址、服务器名称（例如访问API 的人的详细信息），我们还可以继续配置，使用 REST API 的基本flask跟踪应用程序。首先，使用 PIP 命令安装flask跟踪包。

pip install flask-track-usage

接下来看下该程序：

from flask import Flask, g
app = Flask(__name__)
app.config['TRACK_USAGE_USE_FREEGEOIP'] = False
app.config['TRACK_USAGE_INCLUDE_OR_EXCLUDE_VIEWS'] = 'include'
from flask_track_usage import TrackUsage
from flask_track_usage.storage.printer import PrintWriter
from flask_track_usage.storage.output import OutputWriter
t = TrackUsage(app, [
 PrintWriter(),
 OutputWriter(transform=lambda s: "OUTPUT: " + str(s))
])
@t.include
@app.route('/')
def index():
 g.track_var["optional"] = "Write_Something"
 return "Hello"
#Run the application
if __name__ == "__main__":
app.run(debug=True)

该程序通过导入 Track Usage、Input writer 和 output writer 来创建一个跟踪应用程序。将flask app传递给 Track 包并使用输出编写器，并使用 lambda 函数以字符串格式写入输出。之后在 slash 上创建一个基本路由，并将跟踪应用程序作为装饰器包含在内。g 代表全局，表示数据在上下文中是全局的。因此，创建一个基本 API，它在浏览器返回"Hello"，同时在后端获得所有人员的信息。

如何为REST API编写单元测试代码

现在已经为案例创建了一个不错的REST API。尽管如此，我们还需要为REST API编写单元测试代码，因为从API中识别常见错误，并确保生产安全是至关重要的。

如下是创建一个名为run的新文件并开发以下简单API。

from flask import Flask
from flask_restful import Resource, Api
import json
app = Flask(__name__)
api = Api(app)
class Helloworld(Resource):
def __init__(self):
 pass
def get(self):
 return json.dumps({"Message": "Fine"})
api.add_resource(Helloworld, '/')
if __name__ == '__main__':
app.run(debug=True)

现在创建另一个名为test的文件，在其中编写用于对API进行单元测试的代码。最常见的情况是执行以下三个基本单元测试。

• 检查响应码是否为200
• 检查从API编写的内容是否为应用程序JSON格式
• 检查我们正在访问的所有键是否都存在于API数据处理中

from run import app
import unittest
class FlaskTest(unittest.TestCase):
#Check for response 200
def test_inde(self):
 tester = app.test_client(self) #tester object
 response = tester.get("/")
 statuscode = response.status_code
 self.assertEqual(statuscode, 200)
#check if the content return is application JSON
def test_index_content(self):
tester = app.test_client(self)
response = tester.get("/")
self.assertEqual(response.content_type, "application/json")
#check the Data returned
def test_index_data(self):
tester = app.test_client(self)
response = tester.get("/")
self.assertTrue(b'Message' in response.data)
if __name__ == '__main__':
unittest.main()

如果你已经学习过网络爬虫，你应该知道 200 响应意味着对特定 URL 的请求已成功发出，并返回响应。

好了，这就是本文的全部内容。到这里我们已经学会了从头开始创建 Flask REST API ，并轻松安全地对其进行维护。

Flask 作为 Python Web 领域最为著名的轻量级 Web 开发框架，对于致力于 Web 开发的同学来说，掌握基本的 Flask 技能还是非常有必要的，你学会了吗？

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!