在 Web 開發(fā)領(lǐng)域，構(gòu)建堅(jiān)固且綠色的 API 至關(guān)重要。API（應(yīng)用程序編程接口）充當(dāng)軟件程序結(jié)構(gòu)之間的橋梁，允許輕松的口頭交換和記錄更改。Python憑借其靈活性和靈活性，成為不斷增長(zhǎng)的API的流行選擇。在用于此目的的眾多 Python 框架中，F(xiàn)alcon 作為一個(gè)性能卓越、高度簡(jiǎn)單的框架而自豪，它明確設(shè)計(jì)用于構(gòu)建快速且響應(yīng)靈敏的 API。創(chuàng)建 API，并提供一些說明性示例。

什么是 Falcon

Falcon 是一個(gè)Python 的 Web 框架，專注于為構(gòu)建 API 提供一個(gè)極其輕量級(jí)、超全面的性能平臺(tái)。它不是像Django 或 Flask 這樣的全?？蚣?，而是一種特殊的設(shè)備，旨在出色地完成一個(gè)組件：有效地處理 API 請(qǐng)求和響應(yīng) Falcon 的主要目標(biāo)是速度，這使其成為構(gòu)建 API 的最佳選擇，其中性能和可擴(kuò)展性至關(guān)重要。

Falcon 的布局理念圍繞極簡(jiǎn)主義和簡(jiǎn)單性。它具有較小的代碼庫和簡(jiǎn)單的 API，使其易于分析和使用。該框架專為需要快速構(gòu)建 API 并對(duì)功能進(jìn)行一流粒度操作的開發(fā)人員而設(shè)計(jì)。

與 Falcon 相關(guān)的概念

在我們深入使用 Falcon 構(gòu)建 API 之前，請(qǐng)先熟悉框架的一些重要標(biāo)準(zhǔn)和附加內(nèi)容：

1.資源處理程序

• 在 Falcon 中，一個(gè)有用的輔助處理程序是一個(gè) Python 類，它定義特定端點(diǎn) (URL) 需要如何回復(fù)傳入的 HTTP 請(qǐng)求。
• 這種訓(xùn)練通常是從 Falcon 繼承的。資源并實(shí)施各種策略來處理特定的 HTTP 技術(shù)，如 GET、POST、PUT、DELETE 等。
• 資源處理程序是 Falcon 設(shè)計(jì)的核心，使您能夠以簡(jiǎn)單且有組織的方式塑造 API 的真實(shí)判斷。

2.請(qǐng)求和響應(yīng)對(duì)象

• Falcon 提供封裝傳入 HTTP 請(qǐng)求和傳出 HTTP 響應(yīng)的請(qǐng)求和反應(yīng)設(shè)備。
• 這些工具提供了一種方便的方式來獲取請(qǐng)求數(shù)據(jù)和收集響應(yīng)的權(quán)限。
• 您可以在有用的資源處理程序內(nèi)部使用它們來與客戶和服務(wù)器互動(dòng)。

3.路由

• Falcon 中的路由將傳入的 HTTP 請(qǐng)求映射到精確的有用資源處理程序。
• Falcon 提供了一種簡(jiǎn)單直觀的方式來概述 falcon.App 優(yōu)雅用法的路線。
• 您可以通過將輔助處理程序附加到特定的 URL 模式來指定路由，從而輕松安排 API 的端點(diǎn)。

4.中間件

• 中間件是 Falcon 中一個(gè)強(qiáng)大的想法，它允許您對(duì)請(qǐng)求和響應(yīng)執(zhí)行預(yù)處理和提交處理任務(wù)。
• 您可以使用中間件來實(shí)現(xiàn)身份驗(yàn)證、日志記錄或任??何其他需要在多個(gè) API 端點(diǎn)過程中完成的功能。

5.請(qǐng)求解析和驗(yàn)證

• Falcon 提供了用于解析和驗(yàn)證傳入請(qǐng)求信息的小工具，包括問題參數(shù)、請(qǐng)求標(biāo)頭和請(qǐng)求正文。
• 這可以更輕松地確保您的 API 接收有效且格式正確的輸入。

使用 Falcon 構(gòu)建 API 所需的步驟

現(xiàn)在我們已經(jīng)對(duì) Falcon 的中心原則有了穩(wěn)定的專業(yè)知識(shí)，讓我們逐步了解使用 Falcon 構(gòu)建 API 所需的步驟：

1. 安裝

首先，您需要放入 Falcon。您可以使用 Python 包管理器 pip 來做到這一點(diǎn)

pip install falcon

2. 創(chuàng)建 Falcon 應(yīng)用程序

任何完全基于 Falcon 的 API 的基礎(chǔ)都是 falcon.App 項(xiàng)。您創(chuàng)建一個(gè)這種優(yōu)雅的示例來概述您的 API、設(shè)置路由和配置中間件。

import falcon

app = falcon.App(middleware=[
	# Add your middleware here
])

3. 定義資源處理程序

接下來，將輔助處理程序定義為 Python 指令。這些指令繼承自 falcon.Resource 并強(qiáng)制執(zhí)行與它們應(yīng)處理的 HTTP 方法類似的方法（例如，on_get、on_post、on_put、on_delete）。

class HelloWorldResource:
	def on_get(self, req, resp):
		resp.status = falcon.HTTP_200
		resp.text = 'Hello, World!'

4. 將 URL 映射到資源處理程序

您可以通過將 URL 添加到 Falcon 應(yīng)用程序的路由器來將 URL 映射到有用的資源處理程序中。這是通過使用 falcon.App 實(shí)例的 add_route 技術(shù)來完成的。

app.add_route('/hello', HelloWorldResource())

5. 運(yùn)行 Falcon 應(yīng)用程序

最后，您可以使用您想要的 Web 服務(wù)器運(yùn)行 Falcon 軟件。Falcon 符合 WSGI 標(biāo)準(zhǔn)，這意味著您可以使用各種 WSGI 服務(wù)器（例如 Gunicorn 或 uWSGI）來為您的 API 提供服務(wù)。

if __name__ == '__main__':
	from wsgiref import simple_server

	httpd = simple_server.make_server('localhost', 8000, app)
	httpd.serve_forever()

就是這樣！您已經(jīng)創(chuàng)建了一個(gè)基本的 Falcon API。您現(xiàn)在可以向定義的端點(diǎn)發(fā)出 HTTP 請(qǐng)求并從資源處理程序獲取響應(yīng)。

構(gòu)建待辦事項(xiàng)列表 API

在這種情況下，我們創(chuàng)建了一個(gè) TodoResource 來處理 GET 和 POST 請(qǐng)求，以操作待辦事項(xiàng)小工具列表。該 API 允許您使用 GET 請(qǐng)求檢索待辦事項(xiàng)列表，并使用 POST 請(qǐng)求添加新的待辦事項(xiàng)項(xiàng)目。

import falcon
import json

class TodoResource:
	def __init__(self):
		self.todos = []
	def on_get(self, req, resp):
		resp.status = falcon.HTTP_200
		resp.body = json.dumps({'todos': self.todos})
	def on_post(self, req, resp):
		data = req.media
		todo = data.get('todo')
		if todo is not None:
			self.todos.append(todo)
			resp.status = falcon.HTTP_201
			resp.body = json.dumps({'message': 'Todo added successfully'})
		else:
			resp.status = falcon.HTTP_BAD_REQUEST
			resp.body = json.dumps({'error': 'Invalid request'})

app = falcon.App()
app.add_route('/todos', TodoResource())

if __name__ == '__main__':
	from wsgiref import simple_server

	httpd = simple_server.make_server('localhost', 8000, app)
	httpd.serve_forever()

輸出

構(gòu)建帶有身份驗(yàn)證的待辦事項(xiàng)列表 API

在 API 中添加身份驗(yàn)證并不是一個(gè)不尋常的需求。Falcon 中間件功能使身份驗(yàn)證易于應(yīng)用。下面是Falcon內(nèi)置的falcon.Auth中間件的使用實(shí)例。對(duì)于此示例，您可能需要安裝 falcon_auth 包。使用以下命令使用 pip 安裝 falcon_auth 包。

pip install falcon_auth

在此示例中，我們使用 Falcon falcon-auth 中間件對(duì)獨(dú)特技術(shù)進(jìn)行初步身份驗(yàn)證。ProtectedResource 需要身份驗(yàn)證，而 PublicResource 現(xiàn)在不需要。您可以自定義身份驗(yàn)證判斷來滿足您的應(yīng)用程序的需求。

import falcon
from falcon_auth import FalconAuthMiddleware, BasicAuthBackend
auth_backend = BasicAuthBackend(lambda username, password: username == 'user' and password == 'password')
app = falcon.App(middleware=[
	FalconAuthMiddleware(auth_backend, exempt_routes=['/public']),
])
class ProtectedResource:
	def on_get(self, req, resp):
		resp.status = falcon.HTTP_200
		resp.text = 'Authenticated resource'
class PublicResource:
	def on_get(self, req, resp):
		resp.status = falcon.HTTP_200
		resp.text = 'Public resource'

app.add_route('/protected', ProtectedResource())
app.add_route('/public', PublicResource())

if __name__ == '__main__':
	from wsgiref import simple_server
	httpd = simple_server.make_server('localhost', 8000, app)
	httpd.serve_forever()

總結(jié)

Falcon 是一個(gè)在 Python 中構(gòu)建高整體性能 API 的有效子程序。其緊湊的設(shè)計(jì)和對(duì)速度的關(guān)注使其成為需要快速和綠色 API 端點(diǎn)的程序的絕佳選擇。通過了解Falcon的基本概念，按照步驟用Falcon創(chuàng)建API，并探索現(xiàn)實(shí)的例子，您可以使用這個(gè)框架創(chuàng)建一個(gè)強(qiáng)大且綠色的API，滿足您的愿望，特別是關(guān)于是否構(gòu)建一個(gè)簡(jiǎn)單的To-Do列出 API 或?qū)嵤?fù)雜的身份驗(yàn)證機(jī)制，F(xiàn)alcon 提供您在互聯(lián)網(wǎng) API 項(xiàng)目中所需的功能和功能。

到此這篇關(guān)于詳解Python如何使用Falcon構(gòu)建 API的文章就介紹到這了,更多相關(guān)Python Falcon構(gòu)建 API內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論