FastAPI에서 API 문서 및 UI 표시 자동 생성을 구현하는 방법

FastAPI에서 API 문서 및 UI 표시 자동 생성을 구현하는 방법

FastAPI와 같은 강력한 Python 프레임워크를 사용하면 고성능 웹 API를 쉽게 구축할 수 있습니다. 그러나 API를 구축하는 동안 다른 개발자가 API를 이해하고 사용할 수 있도록 명확하고 이해하기 쉬운 API 문서도 필요합니다. 이 기사에서는 FastAPI를 사용하여 API 문서를 자동으로 생성하고 UI를 통해 표시하는 방법을 소개합니다.

먼저 FastAPI 및 관련 종속 라이브러리를 설치해야 합니다. 설치하려면 명령줄에서 다음 명령을 실행하세요.

pip install fastapi
pip install uvicorn
pip install fastapi_utils

다음으로 필요한 모듈을 가져와야 합니다.

from fastapi import FastAPI
from fastapi_utils.api_model import APIModel
from fastapi_utils.api_doc import APIModelDoc

그런 다음 FastAPI의 인스턴스를 만듭니다.

app = FastAPI()

다음으로 API 모델을 정의할 수 있습니다. API 모델은 API 요청 및 응답에 대한 필드를 포함할 수 있는 FastAPI에서 제공하는 APIModel 클래스를 사용하여 정의됩니다. APIModel类来定义的，它可以包含用于API请求和响应的字段。

class User(APIModel):
    id: int
    name: str
    email: str

在我们的FastAPI应用程序中，我们可以使用该模型来定义API路由和逻辑。

@app.get("/users/{user_id}", response_model=User, summary="Get user by ID", tags=["users"])
def get_user(user_id: int):
    return {"id": user_id, "name": "John Doe", "email": "johndoe@example.com"}

在上面的代码中，我们为HTTP GET请求定义了一个路由/users/{user_id}，并指定了响应模型为User。我们还为该路由添加了一个简要说明和一个标签，以后我们可以通过标签来组织和过滤API文档。

接下来，我们可以使用APIModelDoc类来为我们的API模型生成文档。

docs = APIModelDoc(app)
docs.register(User)

有了以上代码，我们的API模型就被注册到了API文档中。

最后，我们需要使用docs.html方法来获取自动生成的API文档的HTML代码。

@api.route('/docs', method="GET", tags=["docs"])
def get_docs():
    return docs.html()

在上面的代码中，我们定义了一个GET路由/docs，并返回了自动生成的API文档的HTML代码。这里我们为这个路由添加了一个标签docs，以便在API文档中进行过滤和组织。

现在，让我们运行我们的FastAPI应用程序并查看自动生成的API文档。

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

在命令行中执行以下命令以启动应用程序：

python app.py

然后在浏览器中访问http://localhost:8000/docsrrreee

FastAPI 애플리케이션에서는 이 모델을 사용하여 API 경로와 로직을 정의할 수 있습니다.

rrreee

위 코드에서는 HTTP GET 요청에 대한 경로 /users/{user_id}를 정의하고 응답 모델을 User로 지정합니다. 또한 나중에 API 문서를 구성하고 필터링하는 데 사용할 수 있는 간단한 설명과 레이블을 경로에 추가했습니다.

다음으로 APIModelDoc 클래스를 사용하여 API 모델에 대한 문서를 생성할 수 있습니다. 🎜rrreee🎜위의 코드를 사용하면 우리의 API 모델이 API 문서에 등록됩니다. 🎜🎜마지막으로 docs.html 메서드를 사용하여 자동으로 생성된 API 문서의 HTML 코드를 가져와야 합니다. 🎜rrreee🎜위 코드에서는 GET 경로 /docs를 정의하고 자동으로 생성된 API 문서의 HTML 코드를 반환합니다. 여기에서는 이 경로에 docs 태그를 추가하여 API 문서에서 경로를 필터링하고 구성합니다. 🎜🎜이제 FastAPI 애플리케이션을 실행하고 자동으로 생성된 API 문서를 살펴보겠습니다. 🎜rrreee🎜명령줄에서 다음 명령을 실행하여 애플리케이션을 시작하세요. 🎜rrreee🎜그런 다음 브라우저에서 http://localhost:8000/docs를 방문하면 자동으로 생성된 내용을 볼 수 있습니다. API 문서. 🎜🎜위의 단계를 통해 FastAPI에서 API 문서의 자동 생성 및 UI 표시를 성공적으로 구현했습니다. 필요에 따라 API 문서의 스타일과 콘텐츠를 추가로 사용자 정의하고 조정할 수 있습니다. 🎜🎜이 기사가 FastAPI를 사용하여 강력한 API를 구축하고 API에 대한 명확하고 이해하기 쉬운 문서를 제공하는 데 도움이 되기를 바랍니다. 🎜

위 내용은 FastAPI에서 API 문서 및 UI 표시 자동 생성을 구현하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!