# 첫걸음
-ê°\80ì\9e¥ ë\8b¨ì\88\9cí\95\9c FastAPI í\8c\8cì\9d¼ì\9d\80 ë\8b¤ì\9d\8cê³¼ ê°\99ì\9d´ ë³´ì\9d¼ ê²\81니다:
+ê°\80ì\9e¥ ë\8b¨ì\88\9cí\95\9c FastAPI í\8c\8cì\9d¼ì\9d\80 ë\8b¤ì\9d\8cê³¼ ê°\99ì\9d´ ë³´ì\9d¼ ê²\83ì\9e\85니다:
```Python
{!../../../docs_src/first_steps/tutorial001.py!}
```
-위를 `main.py`에 복사합니다.
+위 코드를 `main.py`에 복사합니다.
라이브 서버를 실행합니다:
* `main`: 파일 `main.py` (파이썬 "모듈").
* `app`: `main.py` 내부의 `app = FastAPI()` 줄에서 생성한 오브젝트.
- * `--reload`: 코드 변경 í\9b\84 ì\84\9cë²\84 ì\9e¬ì\8b\9cì\9e\91. ê°\9cë°\9cì\97\90ë§\8c ì\82¬ì\9a©.
+ * `--reload`: 코드 변경 ì\8b\9c ì\9e\90ë\8f\99ì\9c¼ë¡\9c ì\84\9cë²\84 ì\9e¬ì\8b\9cì\9e\91. ê°\9cë°\9c ì\8b\9cì\97\90ë§\8c ì\82¬ì\9a©.
-출력에 아래와 같은 줄이 있습니다:
+출력되는 줄들 중에는 아래와 같은 내용이 있습니다:
```hl_lines="4"
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
#### API "스키마"
-
이 경우, <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a>는 API의 스키마를 어떻게 정의하는지 지시하는 규격입니다.
+<a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a>는 API의 스키마를 어떻게 정의하는지 지시하는 규격입니다.
이 스키마 정의는 API 경로, 가능한 매개변수 등을 포함합니다.
#### OpenAPI와 JSON 스키마
-OpenAPI는 API에 대한 API 스키마를 정의합니다. 또한 이 스키마에는 JSON 데이터 스키마의 표준인 **JSON 스키마**를 사용하여 API에서 보내고 받은 데이터의 정의(또는 "스키마")를 포함합니다.
+OpenAPI는 당신의 API에 대한 API 스키마를 정의합니다. 또한 이 스키마는 JSON 데이터 스키마의 표준인 **JSON 스키마**를 사용하여 당신의 API가 보내고 받는 데이터의 정의(또는 "스키마")를 포함합니다.
#### `openapi.json` 확인
-가공되지 않은 OpenAPI 스키마가 어떻게 생겼는지 궁금하다면, FastAPI는 자동으로 API의 설명과 함께 JSON (스키마)를 생성합니다.
+FastAPI는 자동으로 API의 설명과 함께 JSON (스키마)를 생성합니다.
-여기에서 직접 볼 수 있습니다: <a href="http://127.0.0.1:8000/openapi.json" class="external-link" target="_blank">http://127.0.0.1:8000/openapi.json</a>.
+
가공되지 않은 OpenAPI 스키마가 어떻게 생겼는지 궁금하다면, 여기에서 직접 볼 수 있습니다: <a href="http://127.0.0.1:8000/openapi.json" class="external-link" target="_blank">http://127.0.0.1:8000/openapi.json</a>.
다음과 같이 시작하는 JSON을 확인할 수 있습니다:
그리고 OpenAPI의 모든 것을 기반으로 하는 수십 가지 대안이 있습니다. **FastAPI**로 빌드한 애플리케이션에 이러한 대안을 쉽게 추가 할 수 있습니다.
-API와 통신하는 클라이언트를 위해 코드를 자동으로 생성하는 데도 사용할 수 있습니다. 예로 프론트엔드, 모바일, IoT 애플리케이션이 있습니다.
+API와 통신하는 클라이언트(프론트엔드, 모바일, IoT 애플리케이션 등)를 위해 코드를 자동으로 생성하는 데도 사용할 수 있습니다.
## 단계별 요약
{!../../../docs_src/first_steps/tutorial001.py!}
```
-`FastAPI`는 API에 대한 모든 기능을 제공하는 파이썬 클래스입니다.
+`FastAPI`는 당신의 API를 위한 모든 기능을 제공하는 파이썬 클래스입니다.
!!! note "기술 세부사항"
`FastAPI`는 `Starlette`를 직접 상속하는 클래스입니다.
{!../../../docs_src/first_steps/tutorial001.py!}
```
-여기 있는 `app` 변수는 `FastAPI` 클래스의 "인스턴스"가 됩니다.
+여기에서 `app` 변수는 `FastAPI` 클래스의 "인스턴스"가 됩니다.
-이것은 모든 API를 생성하기 위한 상호작용의 주요 지점이 될 것입니다.
+ì\9d´ê²\83ì\9d\80 ë\8b¹ì\8b ì\9d\98 모ë\93 API를 ì\83\9dì\84±í\95\98기 ì\9c\84í\95\9c ì\83\81í\98¸ì\9e\91ì\9a©ì\9d\98 주ì\9a\94 ì§\80ì \90ì\9d´ ë\90 ê²\83ì\9e\85ë\8b\88ë\8b¤.
-이 `app`은 다음 명령에서 `uvicorn`이 참조하고 것과 동일합니다:
+이 `app`은 다음 명령에서 `uvicorn`이 참조하고 있는 것과 동일합니다:
<div class="termy">
</div>
-### 3 단계: *경로 동작* 생성
+### 3 단계: *경로 작동* 생성
#### 경로
-여기서 "경로"는 첫 번째 `/`에서 시작하는 URL의 마지막 부분을 나타냅니다.
+여기서 "경로"는 첫 번째 `/`부터 시작하는 URL의 뒷부분을 의미합니다.
그러므로 아래와 같은 URL에서:
```
!!! info "정보"
- "ê²½ë¡\9c"ë\8a\94 ì\9d¼ë°\98ì \81ì\9c¼ë¡\9c "ì\95¤드포인트" 또는 "라우트"라고도 불립니다.
+ "ê²½ë¡\9c"ë\8a\94 ì\9d¼ë°\98ì \81ì\9c¼ë¡\9c "ì\97\94드포인트" 또는 "라우트"라고도 불립니다.
-API를 빌드하는 동안 "경로"는 "관심사"와 "리소스"를 분리하는 주요 방법입니다.
+API를 설계할 때 "경로"는 "관심사"와 "리소스"를 분리하기 위한 주요한 방법입니다.
-#### 동작
+#### 작동
-여기서 "동작(Operation)"은 HTTP "메소드" 중 하나를 나타냅니다.
+"작동(Operation)"은 HTTP "메소드" 중 하나를 나타냅니다.
다음 중 하나이며:
* `PUT`
* `DELETE`
-...이국적인 것들도 있습니다:
+...흔히 사용되지 않는 것들도 있습니다:
* `OPTIONS`
* `HEAD`
---
-API를 빌드하는 동안 일반적으로 특정 행동을 수행하기 위해 특정 HTTP 메소드를 사용합니다.
+API를 설계할 때 일반적으로 특정 행동을 수행하기 위해 특정 HTTP 메소드를 사용합니다.
-일반적으로 다음을 사용합니다:
+일반적으로 다음과 같습니다:
* `POST`: 데이터를 생성하기 위해.
* `GET`: 데이터를 읽기 위해.
-* `PUT`: ë\8d°ì\9d´í\84°ë¥¼ ì\97\85ë\8d°ì\9d´í\8a¸하기 위해.
+* `PUT`: ë\8d°ì\9d´í\84°ë¥¼ ì\88\98ì \95하기 위해.
* `DELETE`: 데이터를 삭제하기 위해.
-그래서 OpenAPI에서는 각 HTTP 메소드들을 "동작"이라 부릅니다.
+그래서 OpenAPI에서는 각 HTTP 메소드들을 "작동"이라 부릅니다.
-ì\9d´ì \9cë¶\80í\84° ì\9a°ë¦¬ë\8a\94 ë©\94ì\86\8cë\93\9c를 "**ë\8f\99ì\9e\91**"ì\9d´ë\9d¼ê³ ë\8f\84 ë¶\80를ê²\81니다.
+ì\9a°ë¦¬ ì\97ì\8b\9c ì\9d´ì \9cë¶\80í\84° ë©\94ì\86\8cë\93\9c를 "**ì\9e\91ë\8f\99**"ì\9d´ë\9d¼ê³ ë¶\80를 ê²\83ì\9e\85니다.
-#### *경로 동작 데코레이터* 정의
+#### *경로 작동 데코레이터* 정의
```Python hl_lines="6"
{!../../../docs_src/first_steps/tutorial001.py!}
`@app.get("/")`은 **FastAPI**에게 바로 아래에 있는 함수가 다음으로 이동하는 요청을 처리한다는 것을 알려줍니다.
* 경로 `/`
-* <abbr title="HTTP GET 메소드"><code>get</code> 동작</abbr> 사용
+* <abbr title="HTTP GET 메소드"><code>get</code> 작동</abbr> 사용
!!! info "`@decorator` 정보"
이 `@something` 문법은 파이썬에서 "데코레이터"라 부릅니다.
- 함수 맨 위에 놓습니다. 마치 예쁜 장식용(Decorative) 모자처럼(개인적으로 이 용어가 여기서 유래한거 같습니다).
+ 마치 예쁜 장식용(Decorative) 모자처럼(개인적으로 이 용어가 여기서 유래한 것 같습니다) 함수 맨 위에 놓습니다.
- "데코레이터" 아래 있는 함수를 받고 그걸 이용해 무언가 합니다.
+ "데코레이터"는 아래 있는 함수를 받아 그것으로 무언가를 합니다.
- ì\9a°ë¦¬ì\9d\98 ê²½ì\9a°, ì\9d´ ë\8d°ì½\94ë \88ì\9d´í\84°ë\8a\94 **FastAPI**ì\97\90ê²\8c ì\95\84ë\9e\98 í\95¨ì\88\98ê°\80 **ê²½ë¡\9c** `/`ì\97\90 í\95´ë\8b¹í\95\98ë\8a\94 `get` **ë\8f\99ì\9e\91**í\95\98ë\9d¼고 알려줍니다.
+ ì\9a°ë¦¬ì\9d\98 ê²½ì\9a°, ì\9d´ ë\8d°ì½\94ë \88ì\9d´í\84°ë\8a\94 **FastAPI**ì\97\90ê²\8c ì\95\84ë\9e\98 í\95¨ì\88\98ê°\80 **ê²½ë¡\9c** `/`ì\9d\98 `get` **ì\9e\91ë\8f\99**ì\97\90 í\95´ë\8b¹í\95\9cë\8b¤고 알려줍니다.
- 이것이 "**경로 동작 데코레이터**"입니다.
+ 이것이 "**경로 작동 데코레이터**"입니다.
-다른 동작도 쓸 수 있습니다:
+다른 작동도 사용할 수 있습니다:
* `@app.post()`
* `@app.put()`
* `@app.delete()`
-이국적인 것들도 있습니다:
+흔히 사용되지 않는 것들도 있습니다:
* `@app.options()`
* `@app.head()`
* `@app.trace()`
!!! tip "팁"
- 각 동작(HTTP 메소드)을 원하는 대로 사용해도 됩니다.
+ 각 작동(HTTP 메소드)을 원하는 대로 사용해도 됩니다.
**FastAPI**는 특정 의미를 강제하지 않습니다.
- 여기서 정보는 지침서일뿐 요구사항이 아닙니다.
+ 여기서 정보는 지침서일뿐 강제사항이 아닙니다.
- ì\98\88를 ë\93¤ì\96´ GraphQLì\9d\84 ì\82¬ì\9a©í\95 ë\95\8c ì\9d¼ë°\98ì \81ì\9c¼ë¡\9c `POST` ë\8f\99ì\9e\91만 사용하여 모든 행동을 수행합니다.
+ ì\98\88를 ë\93¤ì\96´ GraphQLì\9d\84 ì\82¬ì\9a©í\95\98ë\8a\94 ê²½ì\9a°, ì\9d¼ë°\98ì \81ì\9c¼ë¡\9c `POST` ì\9e\91ë\8f\99만 사용하여 모든 행동을 수행합니다.
-### 4 단계: **경로 동작 함수** 정의
+### 4 단계: **경로 작동 함수** 정의
-다음은 우리의 "**경로 동작 함수**"입니다:
+다음은 우리의 "**경로 작동 함수**"입니다:
* **경로**: 는 `/`입니다.
-* **동작**: 은 `get`입니다.
+* **작동**: 은 `get`입니다.
* **함수**: 는 "데코레이터" 아래에 있는 함수입니다 (`@app.get("/")` 아래).
```Python hl_lines="7"
이것은 파이썬 함수입니다.
-`GET` 동작을 사용하여 URL "`/`"에 대한 요청을 받을 때마다 **FastAPI**에 의해 호출됩니다.
+URL "`/`"에 대한 `GET` 작동을 사용하는 요청을 받을 때마다 **FastAPI**에 의해 호출됩니다.
-위의 경우 `async` 함수입니다.
+위의 예시에서 이 함수는 `async`(비동기) 함수입니다.
---
-`async def` 대신 일반 함수로 정의할 수 있습니다:
+`async def`을 이용하는 대신 일반 함수로 정의할 수 있습니다:
```Python hl_lines="7"
{!../../../docs_src/first_steps/tutorial003.py!}
Pydantic 모델을 반환할 수도 있습니다(나중에 더 자세히 살펴봅니다).
-JSON으로 자동 변환되는 객체들과 모델들이 많이 있습니다(ORM 등을 포함해서요). 가장 마음에 드는 것을 사용하세요, 이미 지원되고 있을 겁니다.
+JSON으로 자동 변환되는 객체들과 모델들(ORM 등을 포함해서)이 많이 있습니다. 가장 마음에 드는 것을 사용하십시오, 이미 지원되고 있을 것입니다.
## 요약
* `FastAPI` 임포트.
* `app` 인스턴스 생성.
-* (`@app.get("/")`처럼) **경로 동작 데코레이터** 작성.
-* (위에 있는 `def root(): ...`처럼) **경로 동작 함수** 작성.
+* (`@app.get("/")`처럼) **경로 작동 데코레이터** 작성.
+* (위에 있는 `def root(): ...`처럼) **경로 작동 함수** 작성.
* (`uvicorn main:app --reload`처럼) 개발 서버 실행.
# 자습서 - 사용자 안내서
-이 자습서는 **FastAPI**의 대부분의 기능을 단계별로 사용하는 방법을 보여줍니다.
+이 자습서는 단계별로 **FastAPI**의 대부분의 기능에 대해 설명합니다.
-ê°\81 ì\84¹ì\85\98ì\9d\80 ì\9d´ì \84 ì\84¹ì\85\98ì\9d\84 기ë°\98í\95´ì\84\9c ì \90ì§\84ì \81ì\9c¼ë¡\9c ë§\8cë\93¤ì\96´ ì¡\8cì§\80ë§\8c, 주ì \9cì\97\90 ë\94°ë\9d¼ ë\8b¤ë¥´ê²\8c 구ì\84±ë\90\98ì\97\88기 ë\95\8c문ì\97\90 í\8a¹ì \95 API ì\9a\94구ì\82¬í\95ì\9d\84 í\95´ê²°í\95\98기 ì\9c\84í\95´ì\84\9cë\9d¼ë©´ ì\96´ë\8a\90 í\8a¹ì \95 í\95목ì\9c¼ë¡\9cë\8d\98ì§\80 ì§\81ì \91 ì\9d´ë\8f\99할 수 있습니다.
+ê°\81 ì\84¹ì\85\98ì\9d\80 ì\9d´ì \84 ì\84¹ì\85\98ì\97\90 기ë°\98í\95\98ë\8a\94 ì\88\9cì°¨ì \81ì\9d¸ 구조ë¡\9c ì\9e\91ì\84±ë\90\98ì\97\88ì§\80ë§\8c, ê°\81 주ì \9cë¡\9c 구ë¶\84ë\90\98ì\96´ ì\9e\88기 ë\95\8c문ì\97\90 í\95\84ì\9a\94ì\97\90 ë\94°ë\9d¼ í\8a¹ì \95 ì\84¹ì\85\98ì\9c¼ë¡\9c ë°\94ë¡\9c ì\9d´ë\8f\99í\95\98ì\97¬ í\95\84ì\9a\94í\95\9c ë\82´ì\9a©ì\9d\84 ë°\94ë¡\9c í\99\95ì\9d¸할 수 있습니다.
-또한 향후 참조가 될 수 있도록 만들어졌습니다.
+또한 향후에도 참조 자료로 쓰일 수 있도록 작성되었습니다.
-그러므로 다시 돌아와서 정확히 필요한 것을 확인할 수 있습니다.
+그러므로 필요할 때에 다시 돌아와서 원하는 것을 정확히 찾을 수 있습니다.
## 코드 실행하기
-모든 코드 블록은 복사하ê³ ì§\81ì \91 ì\82¬ì\9a©í\95 ì\88\98 ì\9e\88ì\8aµë\8b\88ë\8b¤(ì\8b¤ì \9cë¡\9c í\85\8cì\8a¤í\8a¸í\95\9c í\8c\8cì\9d´ì\8d¬ í\8c\8cì\9d¼ì\9e\85ë\8b\88ë\8b¤).
+모든 코드 블록은 복사하ì\97¬ ë°\94ë¡\9c ì\82¬ì\9a©í\95 ì\88\98 ì\9e\88ì\8aµë\8b\88ë\8b¤(ì\8b¤ì \9cë¡\9c í\85\8cì\8a¤í\8a¸ë\90\9c í\8c\8cì\9d´ì\8d¬ í\8c\8cì\9d¼ì\9e\85ë\8b\88ë\8b¤).
예제를 실행하려면 코드를 `main.py` 파일에 복사하고 다음을 사용하여 `uvicorn`을 시작합니다:
</div>
-코드를 작성하거나 복사, 편집할 때, 로컬에서 실행하는 것을 **강력히 장려**합니다.
+코드를 작성하거나 복사, 편집할 때, 로컬 환경에서 실행하는 것을 **강력히 권장**합니다.
+
+로컬 편집기에서 사용한다면, 모든 타입 검사와 자동완성 등 작성해야 하는 코드가 얼마나 적은지 보면서 FastAPI의 비로소 경험할 수 있습니다.
-편집기에서 이렇게 사용한다면, 모든 타입 검사와 자동완성 등 작성해야 하는 코드가 얼마나 적은지 보면서 FastAPI의 장점을 실제로 확인할 수 있습니다.
---
## FastAPI 설치
-첫 번째 단계는 FastAPI 설치입니다.
+첫 번째 단계는 FastAPI를 설치하는 것입니다.
-자습시에는 모든 선택적인 의존성 및 기능을 사용하여 설치할 수 있습니다:
+자습시에는 모든 선택적인 의존성 및 기능을 함께 설치하는 것을 추천합니다:
<div class="termy">
</div>
-...ì½\94ë\93\9c를 ì\8b¤í\96\89í\95\98ë\8a\94 ì\84\9cë²\84ë¡\9c ì\82¬ì\9a©í\95 ì\88\98 ì\9e\88ë\8a\94 `uvicorn` ì\97ì\8b\9c í\8f¬í\95¨í\95\98ê³ ì\9e\88ì\8aµë\8b\88ë\8b¤.
+...ì\9d´ë\8a\94 ì½\94ë\93\9c를 ì\8b¤í\96\89í\95\98ë\8a\94 ì\84\9cë²\84ë¡\9c ì\82¬ì\9a©í\95 ì\88\98 ì\9e\88ë\8a\94 `uvicorn` ë\98\90í\95\9c í\8f¬í\95¨í\95\98ê³ ì\9e\88ì\8aµë\8b\88ë\8b¤.
!!! note "참고"
부분적으로 설치할 수도 있습니다.
이 **자습서 - 사용자 안내서** 다음에 읽을 수 있는 **고급 사용자 안내서**도 있습니다.
-**고급 사용자 안내서**는 현재 문서를 기반으로 하고, 동일한 개념을 사용하며, 추가 기능들을 알려줍니다.
+**고급 사용자 안내서**는 현재 문서를 기반으로 하고, 동일한 개념을 사용하며, 추가적인 기능들에 대해 설명합니다.
-하지만 (지금 읽고 있는) **자습서 - 사용자 안내서**를 먼저 읽는게 좋습니다.
+하지만 (지금 읽고 있는) **자습서 - 사용자 안내서**를 먼저 읽는 것을 권장합니다.
-**자습서 - 사용자 안내서**만으로도 완전한 애플리케이션을 구축할 수 있ì\9c¼ë©°, í\95\84ì\9a\94ì\97\90 ë\94°ë\9d¼ **ê³ ê¸\89 ì\82¬ì\9a©ì\9e\90 ì\95\88ë\82´ì\84\9c**ì\97\90ì\84\9c ì \9cê³µí\95\98ë\8a\94 ëª\87 ê°\80ì§\80 ì¶\94ê°\80ì \81ì\9d¸ 기ë\8a¥ì\9d\84 ì\82¬ì\9a©í\95\98ì\97¬ ë\8b¤ì\96\91í\95\9c ë°©ì\8b\9dì\9c¼ë¡\9c í\99\95ì\9e¥í\95 ì\88\98 ì\9e\88ë\8f\84ë¡\9d ì\84¤ê³\84ë\90\98ì\97\88ì\8aµë\8b\88ë\8b¤.
+**자습서 - 사용자 안내서**만으로도 완전한 애플리케이션을 구축할 수 있ë\8f\84ë¡\9d ì\9e\91ì\84±ë\90\98ì\97\88ì\9c¼ë©°, í\95\84ì\9a\94ì\97\90 ë\94°ë\9d¼ **ê³ ê¸\89 ì\82¬ì\9a©ì\9e\90 ì\95\88ë\82´ì\84\9c**ì\9d\98 ì¶\94ê°\80ì \81ì\9d¸ ì\95\84ì\9d´ë\94\94ì\96´ë¥¼ ì \81ì\9a©í\95\98ì\97¬ ë\8b¤ì\96\91í\95\9c ë°©ì\8b\9dì\9c¼ë¡\9c í\99\95ì\9e¥í\95 ì\88\98 ì\9e\88ì\8aµë\8b\88ë\8b¤.
# 경로 매개변수
-파이썬 포맷 문자열이 사용하는 동일한 문법으로 "매개변수" 또는 "변수"를 경로에 선언할 수 있습니다:
+파이썬의 포맷 문자열 리터럴에서 사용되는 문법을 이용하여 경로 "매개변수" 또는 "변수"를 선언할 수 있습니다:
```Python hl_lines="6-7"
{!../../../docs_src/path_params/tutorial001.py!}
{!../../../docs_src/path_params/tutorial002.py!}
```
-ì§\80ê¸\88ê³¼ ê°\99ì\9d\80 ê²½ì\9a°, `item_id`ë\8a\94 `int`ë¡\9c ì\84 ì\96¸ 되었습니다.
+ì\9c\84ì\9d\98 ì\98\88ì\8b\9cì\97\90ì\84\9c, `item_id`ë\8a\94 `int`ë¡\9c ì\84 ì\96¸되었습니다.
!!! check "확인"
- ì\9d´ 기ë\8a¥ì\9d\80 í\95¨ì\88\98 ë\82´ì\97\90ì\84\9c ì\98¤ë¥\98 ê²\80ì\82¬, ì\9e\90ë\8f\99ì\99\84ì\84± ë\93±ì\9d\84 í\8e¸ì§\91기를 ì§\80ì\9b\90í\95©ë\8b\88ë\8b¤
+ ì\9d´ 기ë\8a¥ì\9d\80 í\95¨ì\88\98 ë\82´ì\97\90ì\84\9c ì\98¤ë¥\98 ê²\80ì\82¬, ì\9e\90ë\8f\99ì\99\84ì\84± ë\93±ì\9d\98 í\8e¸ì§\91기 기ë\8a¥ì\9d\84 í\99\9cì\9a©í\95 ì\88\98 ì\9e\88ê²\8c í\95´ì¤\8dë\8b\88ë\8b¤.
## 데이터 <abbr title="다음으로도 알려져 있습니다: 직렬화, 파싱, 마샬링">변환</abbr>
## 데이터 검증
-하지만 브라우저에서 <a href="http://127.0.0.1:8000/items/foo" class="external-link" target="_blank">http://127.0.0.1:8000/items/foo</a>로 이동하면, 멋진 HTTP 오류를 볼 수 있습니다:
+하지만 브라우저에서 <a href="http://127.0.0.1:8000/items/foo" class="external-link" target="_blank">http://127.0.0.1:8000/items/foo</a>로 이동하면, HTTP 오류가 잘 뜨는 것을 확인할 수 있습니다:
```JSON
{
경로 매개변수 `item_id`는 `int`가 아닌 `"foo"` 값이기 때문입니다.
-`int`
대신 `float`을 전달하면 동일한 오류가 나타납니다: <a href="http://127.0.0.1:8000/items/4.2" class="external-link" target="_blank">http://127.0.0.1:8000/items/4.2</a>
+`int`
가 아닌 `float`을 전달하는 경우에도 동일한 오류가 나타납니다: <a href="http://127.0.0.1:8000/items/4.2" class="external-link" target="_blank">http://127.0.0.1:8000/items/4.2</a>
!!! check "확인"
즉, 파이썬 타입 선언을 하면 **FastAPI**는 데이터 검증을 합니다.
- 오류ë\8a\94 ê²\80ì¦\9dì\9d\84 í\86µê³¼í\95\98ì§\80 못í\95\9c ì§\80ì \90ë\8f\84 ì \95í\99\95í\95\98ê²\8c ëª\85ì\8b\9cí\95©ë\8b\88ë\8b¤.
+ 오류ì\97\90ë\8a\94 ì \95í\99\95í\9e\88 ì\96´ë\8a\90 ì§\80ì \90ì\97\90ì\84\9c ê²\80ì¦\9dì\9d\84 í\86µê³¼í\95\98ì§\80 못í\96\88ë\8a\94ì§\80 ëª\85ì\8b\9cë\90©ë\8b\88ë\8b¤.
이는 API와 상호 작용하는 코드를 개발하고 디버깅하는 데 매우 유용합니다.
<img src="/img/tutorial/path-params/image01.png">
!!! check "확인"
- 다시 한번, 그저 파이썬 타입 선언을 하기만 하면 **FastAPI**는 자동 대화식 API 문서(Swagger UI 통합)를 제공합니다.
+ 그저 파이썬 타입 선언을 하기만 하면 **FastAPI**는 자동 대화형 API 문서(Swagger UI)를 제공합니다.
- 경로 매개변수는 정수형으로 선언됐음을 주목하세요.
+ 경로 매개변수가 정수형으로 명시된 것을 확인할 수 있습니다.
-## 표준 기반의 이점, 대체 문서화
+## 표준 기반의 이점, 대체 문서
그리고 생성된 스키마는 <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md" class="external-link" target="_blank">OpenAPI</a> 표준에서 나온 것이기 때문에 호환되는 도구가 많이 있습니다.
<img src="/img/tutorial/path-params/image02.png">
-이와 마찬가지로 호환되는 도구가 많이 있습니다. 다양한 언어에 대한 코드 생성 도구를 포함합니다.
+이와 마찬가지로 다양한 언어에 대한 코드 생성 도구를 포함하여 여러 호환되는 도구가 있습니다.
## Pydantic
-모든 데이터 검증은 <a href="https://pydantic-docs.helpmanual.io/" class="external-link" target="_blank">Pydantic</a>에 의해 내부적으로 수행되므로 이로 인한 모든 이점을 얻을 수 있습니다. 여러분은 관리를 잘 받고 있음을 느낄 수 있습니다.
+모든 데이터 검증은 <a href="https://pydantic-docs.helpmanual.io/" class="external-link" target="_blank">Pydantic</a>에 의해 내부적으로 수행되므로 이로 인한 이점을 모두 얻을 수 있습니다. 여러분은 관리를 잘 받고 있음을 느낄 수 있습니다.
-`str`, `float`, `bool`과 다른 복잡한 데이터 타입 선언을 할 수 있습니다.
+`str`, `float`, `bool`, 그리고 다른 여러 복잡한 데이터 타입 선언을 할 수 있습니다.
-이 중 몇 가지는 자습서의 다음 장에서 살펴봅니다.
+이 중 몇 가지는 자습서의 다음 장에 설명되어 있습니다.
## 순서 문제
-*경로 동작*을 만들때 고정 경로를 갖고 있는 상황들을 맞닥뜨릴 수 있습니다.
+*경로 작동*을 만들때 고정 경로를 갖고 있는 상황들을 맞닥뜨릴 수 있습니다.
`/users/me`처럼, 현재 사용자의 데이터를 가져온다고 합시다.
사용자 ID를 이용해 특정 사용자의 정보를 가져오는 경로 `/users/{user_id}`도 있습니다.
-*경로 동작*은 순차적으로 평가되기 때문에 `/users/{user_id}` 이전에 `/users/me`를 먼저 선언해야 합니다:
+*경로 작동*은 순차적으로 실행되기 때문에 `/users/{user_id}` 이전에 `/users/me`를 먼저 선언해야 합니다:
```Python hl_lines="6 11"
{!../../../docs_src/path_params/tutorial003.py!}
```
-그렇지 않으면 `/users/{user_id}`는 매ê°\9cë³\80ì\88\98 `user_id`ì\9d\98 ê°\92ì\9d\84 `"me"`ë\9d¼ê³ "ì\83\9dê°\81í\95\98ì\97¬" `/users/me`ë\8f\84 ì\97°ê²°í\95©ë\8b\88ë\8b¤.
+그렇지 않으면 `/users/{user_id}`는 `/users/me` ì\9a\94ì² ë\98\90í\95\9c 매ê°\9cë³\80ì\88\98 `user_id`ì\9d\98 ê°\92ì\9d´ `"me"`ì\9d¸ ê²\83ì\9c¼ë¡\9c "ì\83\9dê°\81í\95\98ê²\8c" ë\90©ë\8b\88ë\8b¤.
## 사전정의 값
-만약 *경로 매개변수*를 받는 *경로
동작*이 있지만, 유효하고 미리 정의할 수 있는 *경로 매개변수* 값을 원한다면 파이썬 표준 <abbr title="열거형(Enumeration)">`Enum`</abbr>을 사용할 수 있습니다.
+만약 *경로 매개변수*를 받는 *경로
작동*이 있지만, *경로 매개변수*로 가능한 값들을 미리 정의하고 싶다면 파이썬 표준 <abbr title="열거형(Enumeration)">`Enum`</abbr>을 사용할 수 있습니다.
### `Enum` 클래스 생성
`Enum`을 임포트하고 `str`과 `Enum`을 상속하는 서브 클래스를 만듭니다.
-`str`ì\9d\84 ì\83\81ì\86\8dí\95¨ì\9c¼ë¡\9cì\8d¨ API 문ì\84\9cë\8a\94 ê°\92ì\9d´ `string` í\98\95ì\9d´ì\96´ì\95¼ í\95\98ë\8a\94 ê²\83ì\9d\84 ì\95\8cê²\8c ë\90\98ê³ ì \9cë\8c\80ë¡\9c ë \8cë\8d\94ë§\81 í\95 ì\88\98 ì\9e\88ê²\8c 됩니다.
+`str`ì\9d\84 ì\83\81ì\86\8dí\95¨ì\9c¼ë¡\9cì\8d¨ API 문ì\84\9cë\8a\94 ê°\92ì\9d´ `string` í\98\95ì\9d´ì\96´ì\95¼ í\95\98ë\8a\94 ê²\83ì\9d\84 ì\95\8cê²\8c ë\90\98ê³ ì\9d´ë\8a\94 문ì\84\9cì\97\90 ì \9cë\8c\80ë¡\9c í\91\9cì\8b\9c됩니다.
-ê³ ì \95ê°\92ì\9c¼ë¡\9c ì\82¬ì\9a©í\95 ì\88\98 ì\9e\88ë\8a\94 ì\9c í\9a¨í\95\9c í\81´ë\9e\98ì\8a¤ ì\96´í\8a¸ë¦¬ë·°í\8a¸ë¥¼ 만듭니다:
+ê°\80ë\8a¥í\95\9c ê°\92ë\93¤ì\97\90 í\95´ë\8b¹í\95\98ë\8a\94 ê³ ì \95ë\90\9c ê°\92ì\9d\98 í\81´ë\9e\98ì\8a¤ ì\96´í\8a¸ë¦¬ë·°í\8a¸ë\93¤ì\9d\84 만듭니다:
```Python hl_lines="1 6-9"
{!../../../docs_src/path_params/tutorial005.py!}
```
!!! info "정보"
- <a href="https://docs.python.org/3/library/enum.html" class="external-link" target="_blank">열거형(또는 enums)</a>은 파이썬 버전 3.4 이후로 사용가능합니다.
+ <a href="https://docs.python.org/3/library/enum.html" class="external-link" target="_blank">열거형(또는 enums)</a>은 파이썬 버전 3.4 이후로 사용 가능합니다.
!!! tip "팁"
- 혹시
헷갈린다면, "AlexNet", "ResNet", 그리고 "LeNet"은 그저 기계 학습 <abbr title="기술적으로 정확히는 딥 러닝 모델 구조">모델</abbr>들의 이름입니다.
+ 혹시
궁금하다면, "AlexNet", "ResNet", 그리고 "LeNet"은 그저 기계 학습 <abbr title="기술적으로 정확히는 딥 러닝 모델 구조">모델</abbr>들의 이름입니다.
### *경로 매개변수* 선언
### 문서 확인
-*경로 매개변수*에 사용할 수 있는 값은 미리 정의되어 있으므로 대화형 문서에서 멋지게 표시됩니다:
+*경로 매개변수*에 사용할 수 있는 값은 미리 정의되어 있으므로 대화형 문서에서 잘 표시됩니다:
<img src="/img/tutorial/path-params/image03.png">
#### *열거형 멤버* 비교
-열거체 `ModelName`의 *열거형 멤버*를 비교할 수 있습니다:
+열거형 `ModelName`의 *열거형 멤버*를 비교할 수 있습니다:
```Python hl_lines="17"
{!../../../docs_src/path_params/tutorial005.py!}
#### *열거형 값* 가져오기
-`model_name.value` 또는 일반적으로 `your_enum_member.value`를 이용하여 실제값(지금의 경우 `str`)을 가져올 수 있습니다:
+`model_name.value` 또는 일반적으로 `your_enum_member.value`를 이용하여 실제 값(위 예시의 경우 `str`)을 가져올 수 있습니다:
```Python hl_lines="20"
{!../../../docs_src/path_params/tutorial005.py!}
#### *열거형 멤버* 반환
-*경로 동작*에서 중첩 JSON 본문(예: `dict`) 역시 *열거형 멤버*를 반환할 수 있습니다.
+*경로 작동*에서 *열거형 멤버*를 반환할 수 있습니다. 이는 중첩 JSON 본문(예: `dict`)내의 값으로도 가능합니다.
클라이언트에 반환하기 전에 해당 값(이 경우 문자열)으로 변환됩니다:
## 경로를 포함하는 경로 매개변수
-`/files/{file_path}`가 있는 *경로 동작*이 있다고 해봅시다.
+경로를 포함하는 *경로 작동* `/files/{file_path}`이 있다고 해봅시다.
-ê·¸ë\9f°ë\8d° ì\97¬ë\9f¬ë¶\84ì\9d\80 `home/johndoe/myfile.txt`ì²\98ë\9f¼ *path*ì\97\90 ë\93¤ì\96´ì\9e\88ë\8a\94 `file_path` ì\9e\90ì²´ê°\80 í\95\84ì\9a\94합니다.
+ê·¸ë\9f°ë\8d° ì\9d´ ê²½ì\9a° `file_path` ì\9e\90ì²´ê°\80 `home/johndoe/myfile.txt`ì\99\80 ê°\99ì\9d\80 ê²½ë¡\9c를 í\8f¬í\95¨í\95´ì\95¼ 합니다.
-따라서 해당 파일의 URL은 다음처럼 됩니다: `/files/home/johndoe/myfile.txt`.
+이때 해당 파일의 URL은 다음처럼 됩니다: `/files/home/johndoe/myfile.txt`.
### OpenAPI 지원
테스트와 정의가 어려운 시나리오로 이어질 수 있으므로 OpenAPI는 *경로*를 포함하는 *경로 매개변수*를 내부에 선언하는 방법을 지원하지 않습니다.
-그럼에도 Starlette의 내부 도구중 하나를 사용하여 **FastAPI**에서는 할 수 있습니다.
+그럼에도 Starlette의 내부 도구중 하나를 사용하여 **FastAPI**에서는 이가 가능합니다.
-매ê°\9cë³\80ì\88\98ì\97\90 ê²½ë¡\9cê°\80 í\8f¬í\95¨ë\90\98ì\96´ì\95¼ í\95\9cë\8b¤ë\8a\94 문ì\84\9c를 ì¶\94ê°\80í\95\98ì§\80 ì\95\8aì\95\84ë\8f\84 문ì\84\9cë\8a\94 ê³\84ì\86\8d 작동합니다.
+문ì\84\9cì\97\90 매ê°\9cë³\80ì\88\98ì\97\90 ê²½ë¡\9cê°\80 í\8f¬í\95¨ë\90\98ì\96´ì\95¼ í\95\9cë\8b¤ë\8a\94 ì \95ë³´ê°\80 ëª\85ì\8b\9cë\90\98ì§\80ë\8a\94 ì\95\8aì§\80ë§\8c ì\97¬ì \84í\9e\88 작동합니다.
### 경로 변환기
-Starletteì\97\90ì\84\9c ì§\81ì \91 ì\98µì\85\98ì\9d\84 ì\82¬ì\9a©í\95\98ë©´ ë\8b¤ì\9d\8cê³¼ ê°\99ì\9d\80 URLì\9d\84 ì\82¬ì\9a©í\95\98ì\97¬ *path*를 í\8f¬í\95¨í\95\98ë\8a\94 *ê²½ë¡\9c 매ê°\9cë³\80ì\88\98*를 ì\84 ì\96¸ 할 수 있습니다:
+Starletteì\9d\98 ì\98µì\85\98ì\9d\84 ì§\81ì \91 ì\9d´ì\9a©í\95\98ì\97¬ ë\8b¤ì\9d\8cê³¼ ê°\99ì\9d\80 URLì\9d\84 ì\82¬ì\9a©í\95¨ì\9c¼ë¡\9cì\8d¨ *path*를 í\8f¬í\95¨í\95\98ë\8a\94 *ê²½ë¡\9c 매ê°\9cë³\80ì\88\98*를 ì\84 ì\96¸할 수 있습니다:
```
/files/{file_path:path}
```
-이러한 경우 매개변수의 이름은 `file_path`이고 마지막 부분 `:path`는 매개변수가 *경로*와 일치해야함을 알려줍니다.
+이러한 경우 매개변수의 이름은 `file_path`이며, 마지막 부분 `:path`는 매개변수가 *경로*와 일치해야 함을 명시합니다.
-ê·¸ë\9f¬ë¯\80ë¡\9c ë\8b¤ì\9d\8cê³¼ ê°\99ì\9d´ ì\82¬ì\9a©í\95 ì\88\98 ì\9e\88ì\8aµë\8b\88ë\8b¤:
+ë\94°ë\9d¼ì\84\9c ë\8b¤ì\9d\8cê³¼ ê°\99ì\9d´ ì\82¬ì\9a©í\95 ì\88\98 ì\9e\88ì\8aµë\8b\88ë\8b¤:
```Python hl_lines="6"
{!../../../docs_src/path_params/tutorial004.py!}
```
!!! tip "팁"
- 매개변수가 `/home/johndoe/myfile.txt`를 ê°\96ê³ ì\9e\88ì\96´ ì\8a¬ë\9e\98ì\8b\9cë¡\9c ì\8b\9cì\9e\91(`/`)í\95´ì\95¼ í\95 ì\88\98 ì\9e\88ì\8aµë\8b\88ë\8b¤.
+ 매개변수가 ê°\80ì ¸ì\95¼ í\95\98ë\8a\94 ê°\92ì\9d´ `/home/johndoe/myfile.txt`ì\99\80 ê°\99ì\9d´ ì\8a¬ë\9e\98ì\8b\9cë¡\9c ì\8b\9cì\9e\91(`/`)í\95´ì\95¼ í\95 ì\88\98 ì\9e\88ì\8aµë\8b\88ë\8b¤.
이 경우 URL은: `/files//home/johndoe/myfile.txt`이며 `files`과 `home` 사이에 이중 슬래시(`//`)가 생깁니다.
## 요약
-**FastAPI**과 함께라면 짧고 직관적인 표준 파이썬 타입 선언을 사용하여 다음을 얻을 수 있습니다:
+**FastAPI**를 이용하면 짧고 직관적인 표준 파이썬 타입 선언을 사용하여 다음을 얻을 수 있습니다:
* 편집기 지원: 오류 검사, 자동완성 등
* 데이터 "<abbr title="HTTP 요청에서 전달되는 문자열을 파이썬 데이터로 변환">파싱</abbr>"
* 데이터 검증
* API 주석(Annotation)과 자동 문서
-위 사항들을 그저 한번에 선언하면 됩니다.
+단 한번의 선언만으로 위 사항들을 모두 선언할 수 있습니다.
-이는 (원래 성능과는 별개로) 대체 프레임워크와 비교했을 때 **FastAPI**의 주요 가시적 장점일 것입니다.
+이는 대체 프레임워크와 비교했을 때 (엄청나게 빠른 성능 외에도) **FastAPI**의 주요한 장점일 것입니다.
# 쿼리 매개변수
-ê²½ë¡\9c 매ê°\9cë³\80ì\88\98ì\9d\98 ì\9d¼ë¶\80ê°\80 ì\95\84ë\8b\8c ë\8b¤ë¥¸ í\95¨ì\88\98 매ê°\9cë³\80ì\88\98를 ì\84 ì\96¸í\95 ë\95\8c, "쿼리" 매개변수로 자동 해석합니다.
+ê²½ë¡\9c 매ê°\9cë³\80ì\88\98ì\9d\98 ì\9d¼ë¶\80ê°\80 ì\95\84ë\8b\8c ë\8b¤ë¥¸ í\95¨ì\88\98 매ê°\9cë³\80ì\88\98를 ì\84 ì\96¸í\95\98ë©´ "쿼리" 매개변수로 자동 해석합니다.
```Python hl_lines="9"
{!../../../docs_src/query_params/tutorial001.py!}
쿼리는 URL에서 `?` 후에 나오고 `&`으로 구분되는 키-값 쌍의 집합입니다.
-예를 들어, URL에서:
+예를 들어, 아래 URL에서:
```
http://127.0.0.1:8000/items/?skip=0&limit=10
URL의 일부이므로 "자연스럽게" 문자열입니다.
-하지만 파이썬 타입과 함께 선언할 경우(위 예에서 `int`), 해당 타입으로 변환ë\90\98ê³ ì\9d´ì\97\90 ë\8c\80í\95´ ê²\80ì¦\9dí\95©ë\8b\88ë\8b¤.
+하지만 파이썬 타입과 함께 선언할 경우(위 예에서 `int`), 해당 타입으로 변환 ë°\8f ê²\80ì¦\9dë\90©ë\8b\88ë\8b¤.
경로 매개변수에 적용된 동일한 프로세스가 쿼리 매개변수에도 적용됩니다:
위 예에서 `skip=0`과 `limit=10`은 기본값을 갖고 있습니다.
-ê·¸ë\9f¬ë¯\80ë¡\9c URLë¡\9c ì\9d´ë\8f\99í\95\98ë©´:
+ê·¸ë\9f¬ë¯\80ë¡\9c URLë¡\9c ì\9d´ë\8f\99í\95\98ë\8a\94 ê²\83ì\9d\80:
```
http://127.0.0.1:8000/items/
```
-ì\95\84ë\9e\98ë¡\9c ì\9d´ë\8f\99í\95\9c 것과 같습니다:
+ì\95\84ë\9e\98ë¡\9c ì\9d´ë\8f\99í\95\98ë\8a\94 것과 같습니다:
```
http://127.0.0.1:8000/items/?skip=0&limit=10
특정값을 추가하지 않고 선택적으로 만들기 위해선 기본값을 `None`으로 설정하면 됩니다.
-그러나 쿼리 매개변수를 필수로 만들려면 기본값을 선언할 수 없습니다:
+그러나 쿼리 매개변수를 필수로 만들려면 단순히 기본값을 선언하지 않으면 됩니다:
```Python hl_lines="6-7"
{!../../../docs_src/query_params/tutorial005.py!}
여기 쿼리 매개변수 `needy`는 `str`형인 필수 쿼리 매개변수입니다.
-브라우저에서 URL을 아래처럼 연다면:
+브라우저에서 아래와 같은 URL을 연다면:
```
http://127.0.0.1:8000/items/foo-item
{!../../../docs_src/query_params/tutorial006.py!}
```
-ì\9d´ ê²½ì\9a° 3가지 쿼리 매개변수가 있습니다:
+ì\9c\84 ì\98\88ì\8b\9cì\97\90ì\84\9cë\8a\94 3가지 쿼리 매개변수가 있습니다:
* `needy`, 필수적인 `str`.
* `skip`, 기본값이 `0`인 `int`.
projects / thirdparty / fastapi / fastapi.git / commitdiff
