python

[fastapi] Field를 사용하여 Request Body로 데이터 받기

아래 코드는 Python 3.10+ 에서 동작한다.1. Field란 무엇인가?Field는 FastAPI에서 Request Body로 전달되는 데이터의 필드를 정의할 때 사용하는 도구이다. Field를 사용하면 기본값 설정, 유효성 검사, 메타데이터 추가 등을 할 수 있다. 이 기능은 주로 Pydantic의 BaseModel과 함께 사용된다.2. 기본적인 Field 사용법우선, Pydantic의 BaseModel을 사용하여 Request Body를 정의하는 기본적인 방법을 알아보자.from fastapi import FastAPIfrom pydantic import BaseModelapp = FastAPI()class Item(BaseModel): name: str description: str..

2024. 8. 16. 08:03

python

[fastapi] Path와 Query 매개변수를 Request Body와 함께 사용하는 방법

1. 기본 개념: Path, Query, 그리고 Request BodyPath 매개변수는 URL 경로에 포함된 변수이다. 예를 들어, /items/{item_id}에서 item_id는 Path 매개변수이다.Query 매개변수는 URL의 ?key=value 형식으로 전달되는 변수이다. 예를 들어, /items/?skip=0&limit=10에서 skip과 limit은 Query 매개변수다.Request Body는 일반적으로 POST, PUT 등의 요청에서 JSON, XML, 또는 다른 형식으로 전송되는 데이터를 말한다.이 세 가지를 혼합하여 사용하는 것은 API에서 매우 유용하며, 클라이언트가 경로와 쿼리 파라미터로 특정 리소스를 식별하거나 요청을 필터링하면서, 본문에서 더 많은 데이터를 전송할 수 있게 한..

2024. 8. 16. 07:41

python

[fastapi] 문자열 검증(String Validation) 이해하기

1. FastAPI와 Pydantic의 검증 기능FastAPI는 데이터 검증을 위해 Pydantic을 활용한다. Pydantic은 파이썬 데이터 모델링 라이브러리로, 입력 데이터의 유효성을 검증하고, 오류를 관리하는 데 최적화되어 있다. FastAPI는 이를 바탕으로 사용자가 입력한 문자열 데이터가 올바른 형식과 조건을 충족하는지 쉽게 확인할 수 있게 한다.2. Query를 사용한 기본 문자열 검증FastAPI에서 문자열 검증을 가장 쉽게 수행할 수 있는 방법은 Query 클래스를 사용하는 것이다. Query는 쿼리 매개변수에 대한 다양한 검증 조건을 설정할 수 있는 유용한 도구이다.from fastapi import FastAPI, Queryapp = FastAPI()@app.get("/items/")..

2024. 8. 16. 07:04

python

[fastapi] 요청 본문 (Request Body)

FastAPI는 Python으로 API를 개발할 때 요청 본문을 간단하고 효율적으로 처리할 수 있는 강력한 기능을 제공한다. 요청 본문(Request Body)란?요청 본문은 클라이언트가 서버로 데이터를 전송할 때 사용하는 HTTP 요청의 일부이다. 일반적으로 POST, PUT, PATCH와 같은 메서드에서 사용되며, JSON, XML, Form 데이터 등 다양한 형식으로 데이터를 전송할 수 있다.FastAPI는 요청 본문을 처리하는 데 있어서 Pydantic 모델을 사용하여 데이터 검증과 변환을 간편하게 해준다. 이를 통해 API 개발자는 구조화된 데이터를 손쉽게 다룰 수 있다.요청 본문 처리의 기본 개념FastAPI에서 요청 본문을 처리하려면, Pydantic 모델을 정의하고 이를 경로 함수의 매개변..

2024. 8. 16. 07:00

python

[fastapi] 쿼리 매개변수 - query parameter

FastAPI는 Python으로 API를 개발할 때 매우 간단하고 효율적으로 쿼리 매개변수를 처리할 수 있는 기능을 제공한다.쿼리 매개변수란?쿼리 매개변수는 URL 경로의 일부가 아닌, ?key=value 형식으로 전달되는 데이터를 의미한다. 예를 들어, https://example.com/items?name=apple&limit=10이라는 URL에서 name과 limit은 쿼리 매개변수이다. 쿼리 매개변수를 사용하면 클라이언트가 다양한 필터링, 정렬, 페이징 등의 조건을 API에 전달할 수 있다.FastAPI는 이러한 쿼리 매개변수를 매우 간단하게 처리할 수 있도록 도와준다.쿼리 매개변수 사용법기본 사용법FastAPI에서 쿼리 매개변수를 정의하려면, 함수의 인자로 이름과 타입을 지정하면 된다. 예를 들..

2024. 8. 16. 06:59

python

[fastapi] path parameter가 중복될 때 어느것이 우선일까?

요구사항예를 들어 사용자 정보 요청 시 아래의 2가지 api가 필요하다고 하자.특정 사용자의 정보 요청/users/{user_id} 나의 정보 요청/users/me이 기능을 위해 아래와 같이 fastapi로 api 만들었다.@app.get("/users/{user_id}")def find_user(user_id): return f"find user: {user_id}"@app.get("/users/me")def find_me(): return "me"그리고 /users/me를 호출해봤다.GET /users/me어느것이 호출이 될까?결론은 위의 /users/{user_id}가 먼저 호출이 된다. 호출결과는 아래와 같다.find user: mejava의 스프링에서는 정적매핑이 있는 경우 api 정..

2024. 8. 16. 06:59

python

[fastapi] 경로 매개변수 - path parameter

FastAPI는 Python으로 API를 개발할 때 경로 매개변수(path parameter)를 간단하고 직관적으로 처리할 수 있는 기능을 제공한다.경로 매개변수란?경로 매개변수는 URL 경로의 일부로 사용되는 변수를 의미한다. 예를 들어, https://example.com/items/42라는 URL에서 42는 경로 매개변수로 사용될 수 있다. 경로 매개변수를 사용하면 클라이언트가 특정 자원에 접근하거나, 동적으로 값을 전달할 수 있게 된다.FastAPI에서는 경로 매개변수를 정의하고 사용하는 것이 매우 간단하다.경로 매개변수 사용법기본 사용법FastAPI에서 경로 매개변수를 정의하려면, 경로 문자열에 중괄호 {}를 사용하면 된다. 예를 들어, 아이템의 ID를 경로 매개변수로 받아서 해당 아이템을 반환..

2024. 8. 16. 06:58

python

[fastapi] 동시성, async/await

FastAPI의 동시성과 async/await 이해하기FastAPI는 최근 인기를 끌고 있는 파이썬 웹 프레임워크로, 비동기 프로그래밍의 장점을 적극 활용할 수 있다. FastAPI는 특히 비동기 I/O 작업에서 높은 성능을 발휘하며, 이를 위해 async와 await 구문을 사용한다. 1. 동시성(Concurrency)과 FastAPI1.1 동시성이란?동시성(Concurrency)은 여러 작업을 동시에 실행할 수 있는 능력을 의미한다. 하지만 이것이 곧 여러 작업이 실제로 동시에 수행된다는 것을 의미하지는 않는다. 일반적으로 동시성은 한 작업이 일시적으로 중단되었을 때, 다른 작업이 그 시간을 활용하여 실행되는 것을 뜻한다. 이는 특히 I/O-bound 작업에서 큰 이점을 제공한다.1.2 동시성의 필요..

2024. 8. 16. 06:57

python

fastapi 소개

FastAPI는 최근 몇 년간 빠르게 인기를 얻고 있는 Python 기반의 웹 프레임워크이다. 여기서 FastAPI의 주요 기능과 장점, 그리고 이를 사용하여 간단한 API를 만드는 방법을 살펴보자.FastAPI란?FastAPI는 Python 3.7+을 기반으로 한 현대적인 웹 프레임워크로, 고성능, 쉬운 사용성, 자동화된 문서화 기능을 제공한다. FastAPI는 Starlette과 Pydantic을 사용하여 높은 성능과 강력한 데이터 검증을 가능하게 한다. 이 프레임워크는 특히 비동기 프로그래밍을 쉽게 할 수 있게 해주며, API 개발을 더욱 효율적으로 만들어준다.FastAPI의 주요 특징고성능: FastAPI는 Uvicorn을 통해 ASGI 서버에서 실행되며, 동시성 처리를 위해 비동기 코드를 자연스..

2024. 8. 16. 06:56

python

pyenv란 무엇인가?

pyenv는 여러 버전의 Python을 쉽게 설치하고 관리할 수 있게 해주는 도구이다. Python 개발자는 다양한 프로젝트에서 서로 다른 버전의 Python을 사용해야 할 때가 많은데, pyenv는 이러한 작업을 매우 간편하게 만들어 준다. pyenv를 사용하면 시스템의 기본 Python 버전을 변경하지 않고도 필요한 버전을 설치하고 사용할 수 있다.pyenv의 주요 기능다중 Python 버전 관리: pyenv를 사용하면 시스템에 여러 버전의 Python을 설치하고, 프로젝트마다 원하는 버전을 설정할 수 있다.버전 간 전환: 프로젝트나 작업에 따라 Python 버전을 손쉽게 전환할 수 있다.버전별 가상 환경 지원: pyenv와 pyenv-virtualenv 플러그인을 함께 사용하면 가상 환경도 쉽게 관..

2024. 8. 2. 13:11