FastAPI 내용 정리#1

FastAPI
Learn
Tutorial - User Guide
Tutorial - User Guide¶
This tutorial shows you how to use FastAPI with most of its features, step by step.

 

Each section gradually builds on the previous ones, but it's structured to separate topics, so that you can go directly to any specific one to solve your specific API needs.

It is also built to work as a future reference.

So you can come back and see exactly what you need.

Run the code¶
All the code blocks can be copied and used directly (they are actually tested Python files).

To run any of the examples, copy the code to a file main.py, and start uvicorn with:

uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

restart ↻
It is HIGHLY encouraged that you write or copy the code, edit it and run it locally.

Using it in your editor is what really shows you the benefits of FastAPI, seeing how little code you have to write, all the type checks, autocompletion, etc.

Install FastAPI¶
The first step is to install FastAPI.

For the tutorial, you might want to install it with all the optional dependencies and features:

fast →
pip install "fastapi[all]"

...that also includes uvicorn, that you can use as the server that runs your code.

Note

You can also install it part by part.

This is what you would probably do once you want to deploy your application to production:


pip install fastapi
Also install uvicorn to work as the server:


pip install "uvicorn[standard]"
And the same for each of the optional dependencies that you want to use.

Advanced User Guide¶
There is also an Advanced User Guide that you can read later after this Tutorial - User guide.

The Advanced User Guide, builds on this, uses the same concepts, and teaches you some extra features.

But you should first read the Tutorial - User Guide (what you are reading right now).

It's designed so that you can build a complete application with just the Tutorial - User Guide, and then extend it in different ways, depending on your needs, using some of the additional ideas from the Advanced User Guide.

위의 문서를 기반으로 fastAPI는 무엇을 하는 것인가?
ChatGPT
FastAPI는 고성능, 쉬운 사용법을 목표로 하는 현대적인, 비동기 지향의 웹 프레임워크입니다. Python 언어로 작성되었으며, API 개발에 특화되어 있습니다. 이 프레임워크는 개발자가 적은 코드로 빠르고 효율적인 API를 구축할 수 있도록 설계되었습니다. 주요 특징은 다음과 같습니다:

성능: FastAPI는 Starlette과 Pydantic을 기반으로 하여 높은 성능을 제공합니다.
타입 힌트: Python의 타입 힌트를 활용하여 에디터 내에서 자동 완성과 타입 체크를 지원합니다. 이는 개발 효율성과 코드의 안정성을 높여 줍니다.
간편한 구동: FastAPI 애플리케이션은 Uvicorn이라는 ASGI 서버를 사용하여 쉽게 구동할 수 있습니다. 개발 중에는 --reload 옵션을 통해 코드 변경이 자동으로 반영됩니다.
문서 자동 생성: FastAPI는 OpenAPI 표준을 따르며, 이를 통해 자동으로 API 문서를 생성합니다. 이 문서는 API의 구조와 사용 방법을 쉽게 파악할 수 있게 해 주며, 대화형 API 테스트도 가능합니다.
FastAPI의 튜토리얼과 사용자 가이드는 단계적으로 프레임워크의 다양한 기능을 소개하면서, 개발자가 필요한 부분만 선택하여 학습할 수 있도록 구성되어 있습니다. 또한, 나중에 참조할 수 있도록 미래의 참조 자료로도 사용될 수 있습니다. 설치는 간단하며 필요한 경우 선택적인 의존성을 포함하여 설치할 수 있습니다. 이러한 방식은 개발 초기 학습 및 실험에 유용하며, 실제 제품을 배포할 때는 필요한 부분만 설치하여 사용하는 것이 일반적입니다.

나는 내가 만든 python 코드가 있다.
엑셀의 자료를 특정 폴더에 넣고, 프로그램을 실행하면 도면형식의 dxf파일을 생성하는 훌륭한 판금제작 프로그램인데, 이를 웹사이트를 통해서 유료로 이 프로그램을 이용하게 만들려고 한다.
아래와 같은 문제가 있는데 도와주길 바란다.

파이썬으로 로컬에서 만든 프로그램을 웹사이트에서 돌아가게 하려면 API형태로 서버를 만들어야 할 것 같다. 그래서 웹사이트에서 엑셀파일을 업로드하고 실행하면 결과물을 다운로드하도록 하는 것이다.
이는 아무나 접근하는 것이 아니라, 내가 미리만들어 놓은 php로 작성된 웹사이트에서 그 고객을 관리하고 또 권한을 부여해줄 것이다.
ChatGPT
웹사이트에서 Python 기반 프로그램을 사용하여 서비스를 제공하는 것은 좋은 아이디어입니다. 이를 위해 FastAPI를 활용한 REST API를 구축하여, 사용자가 엑셀 파일을 업로드하고 변환된 DXF 파일을 다운로드할 수 있게 하는 과정을 아래와 같이 구체적으로 설명드리겠습니다.

1. FastAPI 설치 및 설정
FastAPI를 사용하기 위해 Python 환경에 FastAPI와 Uvicorn 서버를 설치합니다.

bash
Copy code
pip install fastapi uvicorn
2. API 엔드포인트 구현
FastAPI를 사용하여 파일 업로드 및 처리를 위한 API 엔드포인트를 구현합니다. 이 예제에서는 엑셀 파일을 받아 처리 후 DXF 파일로 변환하는 로직을 구현할 것입니다.

python
Copy code
from fastapi import FastAPI, File, UploadFile
from fastapi.responses import FileResponse
import shutil

app = FastAPI()

@app.post("/upload/")
async def create_upload_file(file: UploadFile = File(...)):
    with open("temp_excel.xlsx", "wb") as buffer:
        shutil.copyfileobj(file.file, buffer)
    
    # 파일 처리 로직 호출
    output_file_path = process_excel_to_dxf("temp_excel.xlsx")

    return FileResponse(path=output_file_path, filename="output.dxf")

def process_excel_to_dxf(input_file_path):
    # 여기에 엑셀 파일을 읽고 DXF 파일로 변환하는 코드를 구현
    # 예: output_file_path = convert_to_dxf(input_file_path)
    # 실제 변환 로직에 따라 코드를 작성하시면 됩니다.
    return "path_to_dxf_file.dxf"
3. 권한 관리 및 보안
고객의 권한을 관리하고 PHP 웹사이트와의 통합을 위해 API 보안을 강화해야 합니다. 이를 위해 API 키 또는 OAuth 같은 인증 방식을 사용할 수 있습니다.

python
Copy code
from fastapi import Security, HTTPException
from fastapi.security.api_key import APIKeyHeader

API_KEY = "your_secret_api_key"
api_key_header = APIKeyHeader(name="X-API-Key")

def get_api_key(api_key: str = Security(api_key_header)):
    if api_key == API_KEY:
        return api_key
    else:
        raise HTTPException(status_code=403, detail="Unauthorized")

@app.post("/upload/", dependencies=[Security(get_api_key)])
async def create_upload_file_secure(file: UploadFile = File(...)):
    # 기존 업로드 함수 내용
    pass
4. Uvicorn 서버 실행
개발이 완료되면 로컬 또는 서버에서 Uvicorn을 사용하여 FastAPI 애플리케이션을 실행합니다.

bash
Copy code
uvicorn main:app --reload
5. PHP 웹사이트와의 통합
PHP 웹사이트에서는 CURL 라이브러리나 JavaScript를 사용하여 FastAPI 엔드포인트를 호출할 수 있습니다. 이 때 API 키를 헤더에 포함시켜 요청을 보냄으로써 인증을 처리합니다.

이와 같은 방식으로 당신의 Python 기반 판금제작 프로그램을 웹 API로 변환하고, 기존의 PHP 웹사이트와 통합하여 보다 폭넓은 사용자 기반에 서비스를 제공할 수 있습니다.

from fastapi import FastAPI, File, UploadFile
from fastapi.responses import FileResponse
import shutil

app = FastAPI()

@app.post("/upload/")
async def create_upload_file(file: UploadFile = File(...)):
    with open("temp_excel.xlsm", "wb") as buffer:
        shutil.copyfileobj(file.file, buffer)
    
    # 파일 처리 로직 호출
    output_file_path = process_excel_to_dxf("temp_excel.xlsm")

    return FileResponse(path=output_file_path, filename="output.dxf")

def process_excel_to_dxf(input_file_path):
    # 여기에 엑셀 파일을 읽고 DXF 파일로 변환하는 코드를 구현
    # 예: output_file_path = convert_to_dxf(input_file_path)
    # 실제 변환 로직에 따라 코드를 작성하시면 됩니다.
    return "path_to_dxf_file.dxf"

위와 같이 실행하니 오류만 발생하는는데 실제 호출하는 프로그램을 만들어줘.
ChatGPT
문제를 해결하기 위해 여러분이 엑셀 파일을 DXF 파일로 변환하는 실제 함수를 호출하는 예제를 만들어드리겠습니다. 여기서는 pandas와 matplotlib를 사용하여 기본적인 엑셀 데이터를 읽고 간단한 도면 형식의 그래프를 DXF 파일로 저장하는 예제를 제공합니다. 실제로 matplotlib는 DXF 파일 형식을 직접 지원하지 않으므로, 대신 SVG 형식으로 저장한 후, 필요하다면 추가적인 변환 도구를 사용하여 DXF로 변환할 수 있습니다.

먼저 필요한 라이브러리를 설치합니다:

bash
Copy code
pip install fastapi uvicorn python-multipart pandas matplotlib
다음은 수정된 FastAPI 앱 코드입니다:

python
Copy code
from fastapi import FastAPI, File, UploadFile
from fastapi.responses import FileResponse
import shutil
import pandas as pd
import matplotlib.pyplot as plt

app = FastAPI()

@app.post("/upload/")
async def create_upload_file(file: UploadFile = File(...)):
    with open("temp_excel.xlsx", "wb") as buffer:
        shutil.copyfileobj(file.file, buffer)
    
    # 파일 처리 로직 호출
    output_file_path = process_excel_to_svg("temp_excel.xlsx")

    return FileResponse(path=output_file_path, filename="output.svg")

def process_excel_to_svg(input_file_path):
    # 엑셀 파일을 읽습니다.
    df = pd.read_excel(input_file_path)
    
    # 간단한 플롯을 생성합니다.
    plt.figure()
    df.plot(kind='bar')
    output_file_path = "output.svg"
    plt.savefig(output_file_path)
    plt.close()
    
    return output_file_path

# Uvicorn 서버 실행 코드
# uvicorn 파일명:app --reload
이 코드는 사용자가 업로드한 엑셀 파일을 받아서, 데이터를 읽고 바 차트로 시각화하여 SVG 파일로 저장합니다. SVG는 벡터 형식 파일이며, 이는 도면 파일로 변환하는데 적합합니다.

실제로 DXF 파일로의 변환을 원하신다면, 추가적인 라이브러리나 도구가 필요할 수 있습니다. 예를 들어, ezdxf 라이브러리를 사용하여 Python에서 직접 DXF 파일을 생성하거나 수정할 수 있습니다. DXF 변환은 복잡할 수 있기 때문에, 특정 요구사항이나 DXF 형식의 구체적인 요구 사항에 따라 적절한 변환 스크립트를 작성해야 할 수 있습니다.

PS C:\python\일해이엔지> uvicorn main:app --reload
>> 
INFO:     Will watch for changes in these directories: ['C:\\python\\일해이엔지']
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [30700] using StatReload
INFO:     Started server process [22324]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     127.0.0.1:4226 - "GET / HTTP/1.1" 404 Not Found
ChatGPT
위에서 보여주신 로그는 FastAPI 애플리케이션이 성공적으로 시작되었으며, Uvicorn 서버가 http://127.0.0.1:8000 주소에서 실행 중임을 나타냅니다. 그러나, 로그에서 "404 Not Found" 오류가 나타나고 있는데, 이는 루트 URL (/)에 대한 경로가 API에 정의되지 않았기 때문에 발생하는 것입니다.

API에서 현재 /upload/ 경로에 대한 POST 요청만 처리하도록 설정되어 있기 때문에, 해당 경로를 제외하고 다른 경로로 요청을 보내면 404 오류가 반환됩니다. 만약 루트 경로에 대한 간단한 웰컴 메시지나 API 사용법을 안내하는 페이지를 제공하고 싶다면, 다음과 같이 루트 경로를 위한 또 다른 엔드포인트를 추가할 수 있습니다.

python
Copy code
from fastapi import FastAPI, File, UploadFile, HTTPException
from fastapi.responses import FileResponse, PlainTextResponse
import shutil

app = FastAPI()

@app.get("/")
async def root():
    return PlainTextResponse("Welcome to the DXF Converter API. Use POST /upload/ to upload an Excel file.")

@app.post("/upload/")
async def create_upload_file(file: UploadFile = File(...)):
    if not file.filename.endswith('.xlsx'):
        raise HTTPException(status_code=400, detail="Invalid file format. Please upload an '.xlsx' file.")
        
    path = "temp_excel.xlsx"
    with open(path, "wb") as buffer:
        shutil.copyfileobj(file.file, buffer)

    # 파일 처리 로직 호출
    output_file_path = process_excel_to_dxf(path)

    return FileResponse(path=output_file_path, filename="output.dxf")

def process_excel_to_dxf(input_file_path):
    # 엑셀 파일을 읽고 DXF 파일로 변환하는 코드 구현
    # 예: output_file_path = convert_to_dxf(input_file_path)
    # 여기에 실제 변환 로직을 구현하십시오.
    return "path_to_dxf_file.dxf"
이 코드에는 다음과 같은 추가 기능이 포함되어 있습니다:

루트 경로 (/) 에 대해 간단한 안내 메시지를 반환하는 GET 요청 처리.
파일 업로드 시, 파일 확장자를 확인하여 .xlsx 파일만을 허용하도록 하는 간단한 유효성 검사를 추가하였습니다. 이는 나중에 변환 로직에서 오류를 방지하는 데 도움이 됩니다.
이렇게 수정하면 루트 URL로 접근했을 때도 적절한 응답을 받을 수 있고, 파일 업로드를 보다 안정적으로 처리할 수 있습니다.

WARNING:  StatReload detected changes in 'main.py'. Reloading...
INFO:     Shutting down
INFO:     Waiting for application shutdown.
INFO:     Application shutdown complete.
INFO:     Finished server process [22324]
Process SpawnProcess-1:
Traceback (most recent call last):
  File "C:\Program Files\Python310\lib\multiprocessing\process.py", line 314, in _bootstrap
    self.run()
  File "C:\Program Files\Python310\lib\multiprocessing\process.py", line 108, in run
    self._target(*self._args, **self._kwargs)
  File "C:\Users\light\AppData\Roaming\Python\Python310\site-packages\uvicorn\_subprocess.py", line 78, in subprocess_started
    target(sockets=sockets)
  File "C:\Users\light\AppData\Roaming\Python\Python310\site-packages\uvicorn\server.py", line 65, in run
    return asyncio.run(self.serve(sockets=sockets))
  File "C:\Program Files\Python310\lib\asyncio\runners.py", line 44, in run
    return loop.run_until_complete(main)
  File "C:\Program Files\Python310\lib\asyncio\base_events.py", line 633, in run_until_complete
    self.run_forever()
  File "C:\Program Files\Python310\lib\asyncio\base_events.py", line 600, in run_forever
    self._run_once()
  File "C:\Program Files\Python310\lib\asyncio\base_events.py", line 1896, in _run_once
    handle._run()
  File "C:\Program Files\Python310\lib\asyncio\events.py", line 80, in _run
    self._context.run(self._callback, *self._args)
  File "C:\Users\light\AppData\Roaming\Python\Python310\site-packages\uvicorn\server.py", line 68, in serve
    with self.capture_signals():
  File "C:\Program Files\Python310\lib\contextlib.py", line 142, in __exit__
    next(self.gen)
  File "C:\Users\light\AppData\Roaming\Python\Python310\site-packages\uvicorn\server.py", line 328, in capture_signals
    signal.raise_signal(captured_signal)
KeyboardInterrupt
INFO:     Started server process [26016]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
ChatGPT
제공해 주신 로그를 보면, main.py 파일에 변경이 감지되어 Uvicorn이 서버를 재시작하는 과정에서 예외(KeyboardInterrupt)가 발생했습니다. 이는 개발 중 코드 수정 시 자주 발생할 수 있는 문제이며, 일반적으로 개발자가 서버를 중지하거나 재시작하는 과정에서 발생합니다.

문제 해결 방법
서버 재시작 관련: 서버를 수동으로 재시작할 필요가 없도록, Uvicorn의 --reload 옵션을 계속 사용하세요. 이 옵션은 파일 변경을 자동으로 감지하고 서버를 재시작합니다.
예외 처리: 만약 이 오류가 자주 발생한다면, 코드 수정 과정에서 파일을 저장하기 전에 모든 변경이 완료되었는지 확인하세요. 파일 저장 도중 서버가 재시작을 시도하면 파일이 완전히 로드되지 않아 에러가 발생할 수 있습니다.
서버 로그 확인: 위와 같은 오류가 발생할 때마다 서버 로그를 주의 깊게 확인하세요. 로그가 어떤 문제를 암시하고 있는지 파악하는 것이 중요합니다.
비동기 작업의 예외 처리: FastAPI와 같은 비동기 프레임워크를 사용할 때는 비동기 작업에서 발생할 수 있는 예외를 적절히 처리해야 합니다. 예를 들어, 비동기 작업을 수행하는 동안 발생할 수 있는 예외를 try-except 블록으로 처리하여 안정성을 높일 수 있습니다.
예제 코드 수정
아래는 비동기 작업에서 발생할 수 있는 예외를 처리하는 간단한 예제입니다.

python
Copy code
from fastapi import FastAPI, HTTPException, UploadFile, File
from fastapi.responses import FileResponse
import shutil

app = FastAPI()

@app.post("/upload/")
async def create_upload_file(file: UploadFile = File(...)):
    try:
        path = "temp_excel.xlsx"
        with open(path, "wb") as buffer:
            shutil.copyfileobj(file.file, buffer)
        
        # 파일 처리 로직 호출
        output_file_path = process_excel_to_dxf(path)
        return FileResponse(path=output_file_path, filename="output.dxf")
    except Exception as e:
        raise HTTPException(status_code=500, detail=f"An error occurred: {str(e)}")

def process_excel_to_dxf(input_file_path):
    # 엑셀 파일을 읽고 DXF 파일로 변환하는 코드 구현
    return "path_to_dxf_file.dxf"
이 예제에서는 파일 업로드와 처리 과정에서 발생할 수 있는 예외를 try-except 블록으로 처리하여, 오류가 발생할 경우 클라이언트에 오류 메시지를 전달합니다. 이 방법은 API의 안정성을 높이는 데 도움이 됩니다.