>백엔드 개발 >파이썬 튜토리얼 >매개변수화된 요청에 대해 FastAPI에서 경로 매개변수를 사용하는 방법

매개변수화된 요청에 대해 FastAPI에서 경로 매개변수를 사용하는 방법

王林
王林원래의
2023-07-28 15:13:461224검색

매개변수화된 요청에 대해 FastAPI에서 경로 매개변수를 사용하는 방법

FastAPI는 표준 API(예: Pydantic 및 OpenAPI 사용)를 기반으로 개발된 빠르고(고성능) 사용하기 쉬운 최신 웹 프레임워크입니다. FastAPI에서는 경로 매개변수를 사용하여 요청을 매개변수화하여 다양한 요청을 더 잘 처리할 수 있습니다.

경로 매개변수는 리소스의 특정 인스턴스를 식별하는 URL 부분을 나타냅니다. 경로 매개변수를 사용하면 다양한 요구에 따라 Web API에서 특정 데이터를 얻는 데 도움이 될 수 있습니다. 다음에서는 경로 매개변수를 사용하여 FastAPI에서 매개변수화된 요청을 만드는 방법을 소개하고 해당 코드 예제를 제공합니다.

먼저 FastAPIPath 모듈을 가져와 app 개체를 만들어야 합니다. FastAPIPath模块,并创建一个app对象:

from fastapi import FastAPI, Path

app = FastAPI()

接下来,我们可以在路由路径中定义路径参数。路径参数是由花括号包围的字符串,我们可以在其中定义参数的名称和数据类型。例如,我们可以定义一个item_id的路径参数:

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    return {"item_id": item_id}

在上面的例子中,我们定义了一个/items/{item_id}的路由路径,并将路径参数item_id的数据类型定义为int。在函数参数中,我们可以直接使用路径参数的名称item_id来获取该值。

当我们向服务器发送请求 /items/42时,FastAPI将自动将路径参数的值传递给相应的函数,并将其作为参数的值返回。在上面的例子中,将返回一个JSON对象,该对象包含参数的名称和值:

{"item_id": 42}

我们还可以为路径参数指定其他参数。例如,我们可以指定路径参数的最小值和最大值。下面是一个示例:

@app.get("/users/{user_id}")
async def read_user(user_id: int = Path(..., ge=1, le=100)):
    return {"user_id": user_id}

在上面的例子中,我们使用了gele两个参数限制了user_id的范围,表示user_id的值必须大于等于1且小于等于100。如果我们发送的请求中user_id超出了这个范围,FastAPI将会发送一个HTTP异常响应。

除了常规的数据类型,我们还可以使用枚举类型作为路径参数的数据类型。下面是一个示例:

from enum import Enum

class Size(str, Enum):
    small = "small"
    medium = "medium"
    large = "large"

@app.get("/items/{item_id}/size/{size}")
async def read_item_size(item_id: int, size: Size):
    return {"item_id": item_id, "size": size}

在上面的例子中,我们定义了一个Size枚举类,并将其作为参数size的数据类型。当我们发送请求 /items/42/size/small 时,FastAPI将会将路径参数的值传递给相应的函数,并将其作为参数的值返回。

使用路径参数进行参数化请求是使用FastAPI处理Web API中不同请求的重要技术之一。通过路径参数,我们可以定义不同的路由路径,并根据不同的需求从服务器中获取特定的数据。在上述示例中,我们演示了如何使用路径参数进行参数化请求,并提供了对应的代码示例。

总结一下,在FastAPI中使用路径参数进行参数化请求的步骤如下:

  1. 导入Path模块和FastAPI库。
  2. 创建一个apprrreee
  3. 다음으로 경로를 라우팅할 수 있습니다. 에서 경로 매개변수를 정의합니다. 경로 매개변수는 매개변수의 이름과 데이터 유형을 정의할 수 있는 중괄호로 묶인 문자열입니다. 예를 들어 item_id의 경로 매개변수를 정의할 수 있습니다.
  4. rrreee
  5. 위의 예에서는 /items/{item_id}의 라우팅 경로를 정의하고 데이터를 추가합니다. 경로 매개변수 item_id의 유형은 int로 정의됩니다. 함수 매개변수에서 경로 매개변수 item_id의 이름을 직접 사용하여 값을 가져올 수 있습니다.
  6. /items/42 서버로 요청을 보내면 FastAPI는 자동으로 path 매개변수의 값을 해당 함수에 전달하고 이를 매개변수의 값으로 반환합니다. 위의 예에서는 매개변수의 이름과 값이 포함된 JSON 개체가 반환됩니다.
rrreee

경로 매개변수에 추가 매개변수를 지정할 수도 있습니다. 예를 들어 경로 매개변수의 최소값과 최대값을 지정할 수 있습니다. 예는 다음과 같습니다.

rrreee

위 예에서는 gele 두 매개변수를 사용하여 user_id의 범위를 제한했습니다. user_id 값은 1보다 크거나 같고 100보다 작거나 같아야 합니다. 보내는 요청의 user_id가 이 범위를 초과하는 경우 FastAPI는 HTTP 예외 응답을 보냅니다.

    일반 데이터 유형 외에도 열거 유형을 경로 매개변수의 데이터 유형으로 사용할 수도 있습니다. 예는 다음과 같습니다.
  • rrreee
  • 위 예에서는 Size 열거형 클래스를 정의하고 이를 size 매개변수의 데이터 유형으로 사용합니다. /items/42/size/small로 요청을 보내면 FastAPI는 path 매개변수의 값을 해당 함수에 전달하고 이를 매개변수의 값으로 반환합니다.

경로 매개변수를 사용하는 매개변수화된 요청은 FastAPI를 사용하여 Web API에서 다양한 요청을 처리하는 중요한 기술 중 하나입니다. 경로 매개변수를 통해 다양한 라우팅 경로를 정의하고 다양한 요구에 따라 서버에서 특정 데이터를 얻을 수 있습니다. 위의 예에서는 경로 매개변수를 사용하여 요청을 매개변수화하고 해당 코드 예를 제공하는 방법을 보여줍니다.

🎜요약하자면, 경로 매개변수를 사용하여 FastAPI에서 매개변수화된 요청을 만드는 단계는 다음과 같습니다. 🎜
    🎜 Path 모듈과 FastAPI 라이브러리를 가져옵니다. 🎜🎜애플리케이션의 인스턴스로 app 개체를 만듭니다. 🎜🎜라우팅 경로에서 경로 매개변수를 정의하고 중괄호를 사용하여 매개변수를 묶습니다. 🎜🎜해당 함수에서는 경로 매개변수의 이름을 직접 사용하여 매개변수의 값을 가져올 수 있습니다. 🎜🎜🎜경로 매개변수를 사용하면 다양한 요청을 더 잘 처리하고 서버에서 특정 데이터를 정확하게 얻는 데 도움이 될 수 있습니다. 🎜🎜참조: 🎜🎜🎜[FastAPI 문서](https://fastapi.tiangolo.com/)🎜🎜🎜이 문서가 FastAPI에서 매개변수화된 요청을 생성하기 위해 경로 매개변수를 사용하는 방법을 이해하는 데 도움이 되기를 바랍니다. 🎜

위 내용은 매개변수화된 요청에 대해 FastAPI에서 경로 매개변수를 사용하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.