Swagger UI를 사용하여 FastAPI에서 API 문서를 표시하는 방법-파이썬 튜토리얼-php.cn

Swagger UI를 사용하여 FastAPI에서 API 문서를 표시하는 방법

王林

풀어 주다： 2023-07-30 10:45:32

원래의

2976명이 탐색했습니다.

Swagger UI를 사용하여 FastAPI에서 API 문서를 표시하는 방법

소개:
현대 웹 개발에서 API는 필수적인 부분입니다. 개발과 유지 관리를 용이하게 하기 위해서는 다른 개발자가 API를 이해하고 사용할 수 있도록 친숙하고 사용하기 쉬운 API 문서를 제공해야 합니다. Swagger는 API의 세부 정보를 시각적으로 표시할 수 있는 대화형 UI 인터페이스를 제공하는 널리 사용되는 API 문서 형식이자 도구입니다. 이 기사에서는 FastAPI에서 Swagger UI를 사용하여 API 문서를 표시하는 방법을 보여 드리겠습니다.

종속성 설치
먼저 FastAPI 및 관련 종속성을 설치해야 합니다. 다음 명령을 사용하여 설치할 수 있습니다.
```
pip install fastapi[all]
```
로그인 후 복사
이렇게 하면 FastAPI와 Swagger UI를 포함하여 필요한 모든 종속성이 설치됩니다.
FastAPI 애플리케이션 생성
다음으로 FastAPI 애플리케이션을 생성하겠습니다. 새 Python 파일에 다음 코드를 작성합니다.
```
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
 return {"message": "Hello World"}
```
로그인 후 복사
이 간단한 애플리케이션은 간단한 "Hello World" 메시지를 반환하는 루트 경로를 정의합니다.

Swagger UI 추가
Swagger UI를 애플리케이션에 추가하려면 관련 FastAPI 구성 요소를 가져와야 합니다. 앱 파일에 다음 코드를 추가합니다.

from fastapi import FastAPI
from fastapi.openapi.utils import get_openapi
from fastapi.openapi.docs import get_swagger_ui_html

app = FastAPI()

@app.get("/")
async def root():
 return {"message": "Hello World"}

def custom_swagger_ui_html(*, request):
 openapi_url = app.openapi_url
 swagger_url = openapi_url.replace("/openapi.json", "/swagger")
 return get_swagger_ui_html(
     openapi_url=openapi_url,
     title=app.title + " - Swagger UI",
     oauth2_redirect_url=swagger_url + "/oauth2-redirect.html",
     swagger_js_url="/static/swagger-ui-bundle.js",
     swagger_css_url="/static/swagger-ui.css",
 )

app.openapi = get_openapi(title="My API")

@app.get("/swagger", include_in_schema=False)
async def swagger_ui_html(request: Request):
 return custom_swagger_ui_html(request=request)

app.mount("/static", StaticFiles(directory="static"), name="static")

로그인 후 복사

코드에서 custom_swagger_ui_html이라는 사용자 정의 함수를 생성합니다. 이 함수는 FastAPI에서 제공하는 get_swagger_ui_html 함수를 사용하여 Swagger UI의 HTML 페이지를 생성합니다. 또한 Swagger UI용 정적 파일에 대한 일부 URL과 경로를 정의했습니다. custom_swagger_ui_html的自定义函数。这个函数将使用FastAPI提供的get_swagger_ui_html函数来生成Swagger UI的HTML页面。我们还为Swagger UI定义了一些URL和静态文件的路径。

运行应用
现在我们的应用已经准备就绪，可以运行它了。在终端中，使用以下命令来启动应用：
```
uvicorn main:app --reload
```
로그인 후 복사
这将启动我们的应用，并使其运行在本地的默认地址http://localhost:8000上。
查看API文档
在浏览器中打开http://localhost:8000/swagger

앱 실행
이제 앱이 준비되었으므로 실행할 수 있습니다. 터미널에서 다음 명령을 사용하여 애플리케이션을 시작합니다.

rrreee

이렇게 하면 애플리케이션이 시작되고 기본 주소 http://localhost:8000에서 로컬로 실행됩니다.

🎜🎜API 문서 보기🎜브라우저에서 http://localhost:8000/swagger를 열면 대화형 Swagger UI 인터페이스가 표시됩니다. 라우팅, 요청 및 응답 모델 등을 포함한 API의 세부 정보가 표시됩니다. 🎜🎜🎜결론: 🎜FastAPI 및 Swagger UI를 사용하면 API 문서를 쉽게 표시하고 찾아볼 수 있습니다. 이를 통해 개발자는 API를 더 쉽게 이해하고 사용할 수 있습니다. 이 기사가 Swagger UI를 사용하여 FastAPI에서 API 문서를 표시하는 데 도움이 되기를 바랍니다. 🎜🎜위 내용은 Swagger UI를 사용하여 FastAPI에서 API 문서를 표시하는 방법에 대한 안내입니다. 이 기사가 도움이 되기를 바랍니다. 읽어 주셔서 감사합니다! 🎜

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