FastAPI에서 OpenAPI 사양을 사용하여 API 인터페이스를 정의하는 방법

FastAPI에서 OpenAPI 사양을 사용하여 API 인터페이스를 정의하는 방법

소개:
웹 API를 작성할 때 좋은 API 문서가 매우 중요합니다. 개발자가 API를 빠르게 이해하고 사용할 수 있도록 명확한 문서와 인터페이스 정의를 제공할 수 있습니다. OpenAPI 사양은 표준 기반 방식으로 API 문서를 정의하고 생성할 수 있는 강력한 기능과 생태계 지원을 갖춘 범용 API 설명 언어입니다. FastAPI는 OpenAPI 사양을 완벽하게 통합하고 강력한 자동화된 문서 생성 및 확인 기능을 제공하는 최신 Python 웹 프레임워크입니다. 이 기사에서는 OpenAPI 사양을 사용하여 FastAPI에서 API 인터페이스를 정의하고 해당 코드 예제를 제공하는 방법을 소개합니다.

1. FastAPI 및 pydantic 라이브러리 설치
시작하기 전에 FastAPI 및 pydantic 라이브러리를 설치해야 합니다. 다음 명령을 통해 설치할 수 있습니다.

pip install fastapi
pip install uvicorn[standard]
pip install pydantic

2. 간단한 API 인터페이스 만들기
먼저 OpenAPI 사양을 사용하는 방법을 보여주기 위해 간단한 API 인터페이스를 만듭니다. main.py라는 파일에 다음 코드를 작성합니다. main.py的文件中，写入以下代码：

from fastapi import FastAPI

app = FastAPI()

@app.get("/hello")
def hello():
    return {"message": "Hello, World!"}

这段代码创建了一个/hello的GET请求接口，并返回一个包含message字段的JSON响应。接下来，我们需要运行这个应用。可以通过以下命令来运行：

uvicorn main:app --reload

三、生成OpenAPI文档
运行应用后，可以在浏览器中打开http://localhost:8000/docs来访问自动生成的API文档。这个页面是由FastAPI自动生成基于OpenAPI规范的文档。你可以看到/hello接口的详细信息，包括路径、请求方法、请求参数和响应示例。并且，你还可以在文档页面中测试这个接口。

四、使用参数定义
在现实的应用中，我们通常需要使用参数来接收用户的输入。FastAPI提供了多种方式来定义参数，包括路径参数、查询参数、请求体参数和请求头参数。下面我们将演示如何使用这些参数。

4.1 路径参数
路径参数是URL中的一部分，它们用于接收动态变量。我们可以通过{}来定义一个路径参数。在下面的示例中，我们创建了一个接受用户ID作为路径参数的接口。

from fastapi import FastAPI

app = FastAPI()

@app.get("/users/{user_id}")
def get_user(user_id: int):
    return {"user_id": user_id}

通过运行应用，然后在浏览器中访问http://localhost:8000/users/1，你将得到一个JSON响应{"user_id": 1}。

4.2 查询参数
查询参数是URL中的一部分，用于接收用户传递的键值对。在FastAPI中，查询参数可以通过函数参数中的默认值来定义。在下面的示例中，我们创建了一个接受limit和offset查询参数的接口。

from fastapi import FastAPI

app = FastAPI()

@app.get("/users/")
def get_users(limit: int = 10, offset: int = 0):
    return {"limit": limit, "offset": offset}

通过运行应用，然后在浏览器中访问http://localhost:8000/users/?limit=20&offset=10，你将得到一个JSON响应{"limit": 20, "offset": 10}。

4.3 请求体参数
请求体参数是通过HTTP请求体传递的数据，通常用于接收较大的数据。在FastAPI中，请求体参数可以通过pydantic库的模型来定义。在下面的示例中，我们创建了一个接受用户信息作为请求体参数的接口。

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    name: str
    age: int

@app.post("/users/")
def create_user(user: User):
    return {"user": user}

运行应用后，使用工具如curl发送一个POST请求：

curl -X POST -H "Content-Type: application/json" -d '{"name":"Alice", "age": 25}' http://localhost:8000/users/

你将得到一个JSON响应{"user": {"name": "Alice", "age": 25}}。

4.4 请求头参数
请求头参数是通过HTTP请求头传递的参数，通常用于传递安全验证信息。在FastAPI中，请求头参数可以在函数参数中使用Header()方法来定义。在下面的示例中，我们创建了一个接受api_key请求头参数的接口。

from fastapi import FastAPI, Header

app = FastAPI()

@app.get("/protected/")
def protected(api_key: str = Header(...)):
    return {"api_key": api_key}

通过运行应用，然后在浏览器中访问http://localhost:8000/protected/并携带自定义的api_key请求头，你将得到一个JSON响应{"api_key": <your_api_key>}rrreee

rrreee
3. OpenAPI 문서 생성

위 내용은 FastAPI에서 OpenAPI 사양을 사용하여 API 인터페이스를 정의하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!