Browse Source

๐ŸŒ Add Korean translation for Tutorial - Path Parameters and Numeric Validations (#2432)

pull/4272/head
Spike 3 years ago
committed by GitHub
parent
commit
a5d697b9b5
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 122
      docs/ko/docs/tutorial/path-params-numeric-validations.md
  2. 1
      docs/ko/mkdocs.yml

122
docs/ko/docs/tutorial/path-params-numeric-validations.md

@ -0,0 +1,122 @@
# ๊ฒฝ๋กœ ๋งค๊ฐœ๋ณ€์ˆ˜์™€ ์ˆซ์ž ๊ฒ€์ฆ
`Query`๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์ฟผ๋ฆฌ ๋งค๊ฐœ๋ณ€์ˆ˜์— ๋” ๋งŽ์€ ๊ฒ€์ฆ๊ณผ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์„ ์–ธํ•˜๋Š” ๋ฐฉ๋ฒ•๊ณผ ๋™์ผํ•˜๊ฒŒ `Path`๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๊ฒฝ๋กœ ๋งค๊ฐœ๋ณ€์ˆ˜์— ๊ฒ€์ฆ๊ณผ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ๊ฐ™์€ ํƒ€์ž…์œผ๋กœ ์„ ์–ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
## ๊ฒฝ๋กœ ์ž„ํฌํŠธ
๋จผ์ € `fastapi`์—์„œ `Path`๋ฅผ ์ž„ํฌํŠธํ•ฉ๋‹ˆ๋‹ค:
```Python hl_lines="3"
{!../../../docs_src/path_params_numeric_validations/tutorial001.py!}
```
## ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ ์„ ์–ธ
`Query`์— ๋™์ผํ•œ ๋งค๊ฐœ๋ณ€์ˆ˜๋ฅผ ์„ ์–ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
์˜ˆ๋ฅผ ๋“ค์–ด, `title` ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ ๊ฐ’์„ ๊ฒฝ๋กœ ๋งค๊ฐœ๋ณ€์ˆ˜ `item_id`์— ์„ ์–ธํ•˜๋ ค๋ฉด ๋‹ค์Œ๊ณผ ๊ฐ™์ด ์ž…๋ ฅํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค:
```Python hl_lines="10"
{!../../../docs_src/path_params_numeric_validations/tutorial001.py!}
```
!!! note "์ฐธ๊ณ "
๊ฒฝ๋กœ ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ๊ฒฝ๋กœ์˜ ์ผ๋ถ€์—ฌ์•ผ ํ•˜๋ฏ€๋กœ ์–ธ์ œ๋‚˜ ํ•„์ˆ˜์ ์ž…๋‹ˆ๋‹ค.
์ฆ‰, `...`๋กœ ์„ ์–ธํ•ด์„œ ํ•„์ˆ˜์ž„์„ ๋‚˜ํƒ€๋‚ด๋Š”๊ฒŒ ์ข‹์Šต๋‹ˆ๋‹ค.
๊ทธ๋Ÿผ์—๋„ `None`์œผ๋กœ ์„ ์–ธํ•˜๊ฑฐ๋‚˜ ๊ธฐ๋ณธ๊ฐ’์„ ์ง€์ •ํ• ์ง€๋ผ๋„ ์•„๋ฌด ์˜ํ–ฅ์„ ๋ผ์น˜์ง€ ์•Š์œผ๋ฉฐ ์–ธ์ œ๋‚˜ ํ•„์ˆ˜์ž…๋‹ˆ๋‹ค.
## ํ•„์š”ํ•œ ๊ฒฝ์šฐ ๋งค๊ฐœ๋ณ€์ˆ˜ ์ •๋ ฌํ•˜๊ธฐ
`str` ํ˜•์ธ ์ฟผ๋ฆฌ ๋งค๊ฐœ๋ณ€์ˆ˜ `q`๋ฅผ ํ•„์ˆ˜๋กœ ์„ ์–ธํ•˜๊ณ  ์‹ถ๋‹ค๊ณ  ํ•ด๋ด…์‹œ๋‹ค.
ํ•ด๋‹น ๋งค๊ฐœ๋ณ€์ˆ˜์— ๋Œ€ํ•ด ์•„๋ฌด๋Ÿฐ ์„ ์–ธ์„ ํ•  ํ•„์š”๊ฐ€ ์—†์œผ๋ฏ€๋กœ `Query`๋ฅผ ์ •๋ง๋กœ ์จ์•ผํ•  ํ•„์š”๋Š” ์—†์Šต๋‹ˆ๋‹ค.
ํ•˜์ง€๋งŒ `item_id` ๊ฒฝ๋กœ ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ์—ฌ์ „ํžˆ `Path`๋ฅผ ์‚ฌ์šฉํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.
ํŒŒ์ด์ฌ์€ "๊ธฐ๋ณธ๊ฐ’"์ด ์—†๋Š” ๊ฐ’ ์•ž์— "๊ธฐ๋ณธ๊ฐ’"์ด ์žˆ๋Š” ๊ฐ’์„ ์ž…๋ ฅํ•˜๋ฉด ๋ถˆํ‰ํ•ฉ๋‹ˆ๋‹ค.
๊ทธ๋Ÿฌ๋‚˜ ๋งค๊ฐœ๋ณ€์ˆ˜๋“ค์„ ์žฌ์ •๋ ฌํ•จ์œผ๋กœ์จ ๊ธฐ๋ณธ๊ฐ’(์ฟผ๋ฆฌ ๋งค๊ฐœ๋ณ€์ˆ˜ `q`)์ด ์—†๋Š” ๊ฐ’์„ ์ฒ˜์Œ ๋ถ€๋ถ„์— ์œ„์น˜ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
**FastAPI**์—์„œ๋Š” ์ค‘์š”ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ์ด๋ฆ„, ํƒ€์ž… ๊ทธ๋ฆฌ๊ณ  ์„ ์–ธ๊ตฌ(`Query`, `Path` ๋“ฑ)๋กœ ๋งค๊ฐœ๋ณ€์ˆ˜๋ฅผ ๊ฐ์ง€ํ•˜๋ฉฐ ์ˆœ์„œ๋Š” ์‹ ๊ฒฝ ์“ฐ์ง€ ์•Š์Šต๋‹ˆ๋‹ค.
๋”ฐ๋ผ์„œ ํ•จ์ˆ˜๋ฅผ ๋‹ค์Œ๊ณผ ๊ฐ™์ด ์„ ์–ธ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค:
```Python hl_lines="8"
{!../../../docs_src/path_params_numeric_validations/tutorial002.py!}
```
## ํ•„์š”ํ•œ ๊ฒฝ์šฐ ๋งค๊ฐœ๋ณ€์ˆ˜ ์ •๋ ฌํ•˜๊ธฐ, ํŠธ๋ฆญ
`Query`๋‚˜ ์•„๋ฌด๋Ÿฐ ๊ธฐ๋ณธ๊ฐ’์œผ๋กœ๋„ `q` ๊ฒฝ๋กœ ๋งค๊ฐœ๋ณ€์ˆ˜๋ฅผ ์„ ์–ธํ•˜๊ณ  ์‹ถ์ง€ ์•Š์ง€๋งŒ `Path`๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๊ฒฝ๋กœ ๋งค๊ฐœ๋ณ€์ˆ˜๋ฅผ `item_id` ๋‹ค๋ฅธ ์ˆœ์„œ๋กœ ์„ ์–ธํ•˜๊ณ  ์‹ถ๋‹ค๋ฉด, ํŒŒ์ด์ฌ์€ ์ด๋ฅผ ์œ„ํ•œ ์ž‘๊ณ  ํŠน๋ณ„ํ•œ ๋ฌธ๋ฒ•์ด ์žˆ์Šต๋‹ˆ๋‹ค.
`*`๋ฅผ ํ•จ์ˆ˜์˜ ์ฒซ ๋ฒˆ์งธ ๋งค๊ฐœ๋ณ€์ˆ˜๋กœ ์ „๋‹ฌํ•˜์„ธ์š”.
ํŒŒ์ด์ฌ์€ `*`์œผ๋กœ ์•„๋ฌด๋Ÿฐ ํ–‰๋™๋„ ํ•˜์ง€ ์•Š์ง€๋งŒ, ๋”ฐ๋ฅด๋Š” ๋งค๊ฐœ๋ณ€์ˆ˜๋“ค์€ <abbr title="์œ ๋ž˜: K-ey W-ord Arg-uments"><code>kwargs</code></abbr>๋กœ๋„ ์•Œ๋ ค์ง„ ํ‚ค์›Œ๋“œ ์ธ์ž(ํ‚ค-๊ฐ’ ์Œ)์—ฌ์•ผ ํ•จ์„ ์ธ์ง€ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’์„ ๊ฐ€์ง€๊ณ  ์žˆ์ง€ ์•Š๋”๋ผ๋„ ๊ทธ๋ ‡์Šต๋‹ˆ๋‹ค.
```Python hl_lines="8"
{!../../../docs_src/path_params_numeric_validations/tutorial003.py!}
```
## ์ˆซ์ž ๊ฒ€์ฆ: ํฌ๊ฑฐ๋‚˜ ๊ฐ™์Œ
`Query`์™€ `Path`(๋‚˜์ค‘์— ๋ณผ ๋‹ค๋ฅธ ๊ฒƒ๋“ค๋„)๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๋ฌธ์ž์—ด ๋ฟ๋งŒ ์•„๋‹ˆ๋ผ ์ˆซ์ž์˜ ์ œ์•ฝ์„ ์„ ์–ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
์—ฌ๊ธฐ์„œ `ge=1`์ธ ๊ฒฝ์šฐ, `item_id`๋Š” `1`๋ณด๋‹ค "ํฌ๊ฑฐ๋‚˜(`g`reater) ๊ฐ™์€(`e`qual)" ์ •์ˆ˜ํ˜• ์ˆซ์ž์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค.
```Python hl_lines="8"
{!../../../docs_src/path_params_numeric_validations/tutorial004.py!}
```
## ์ˆซ์ž ๊ฒ€์ฆ: ํฌ๊ฑฐ๋‚˜ ๊ฐ™์Œ ๋ฐ ์ž‘๊ฑฐ๋‚˜ ๊ฐ™์Œ
๋™์ผํ•˜๊ฒŒ ์ ์šฉ๋ฉ๋‹ˆ๋‹ค:
* `gt`: ํฌ๊ฑฐ๋‚˜(`g`reater `t`han)
* `le`: ์ž‘๊ฑฐ๋‚˜ ๊ฐ™์€(`l`ess than or `e`qual)
```Python hl_lines="9"
{!../../../docs_src/path_params_numeric_validations/tutorial005.py!}
```
## ์ˆซ์ž ๊ฒ€์ฆ: ๋ถ€๋™์†Œ์ˆ˜, ํฌ๊ฑฐ๋‚˜ ๋ฐ ์ž‘๊ฑฐ๋‚˜
์ˆซ์ž ๊ฒ€์ฆ์€ `float` ๊ฐ’์—๋„ ๋™์ž‘ํ•ฉ๋‹ˆ๋‹ค.
์—ฌ๊ธฐ์—์„œ <abbr title="greater than or equal"><code>ge</code></abbr>๋ฟ๋งŒ ์•„๋‹ˆ๋ผ <abbr title="greater than"><code>gt</code></abbr>๋ฅผ ์„ ์–ธ ํ•  ์ˆ˜์žˆ๋Š” ๊ฒƒ์ด ์ค‘์š”ํ•ด์ง‘๋‹ˆ๋‹ค. ์˜ˆ๋ฅผ ๋“ค์–ด ํ•„์š”ํ•œ ๊ฒฝ์šฐ, ๊ฐ’์ด `1`๋ณด๋‹ค ์ž‘๋”๋ผ๋„ ๋ฐ˜๋“œ์‹œ `0`๋ณด๋‹ค ์ปค์•ผํ•ฉ๋‹ˆ๋‹ค.
์ฆ‰, `0.5`๋Š” ์œ ํšจํ•œ ๊ฐ’์ž…๋‹ˆ๋‹ค. ๊ทธ๋Ÿฌ๋‚˜ `0.0` ๋˜๋Š” `0`์€ ๊ทธ๋ ‡์ง€ ์•Š์Šต๋‹ˆ๋‹ค.
<abbr title="less than"><code>lt</code></abbr> ์—ญ์‹œ ๋งˆ์ฐฌ๊ฐ€์ง€์ž…๋‹ˆ๋‹ค.
```Python hl_lines="11"
{!../../../docs_src/path_params_numeric_validations/tutorial006.py!}
```
## ์š”์•ฝ
`Query`, `Path`(์•„์ง ๋ณด์ง€ ๋ชปํ•œ ๋‹ค๋ฅธ ๊ฒƒ๋“ค๋„)๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด [์ฟผ๋ฆฌ ๋งค๊ฐœ๋ณ€์ˆ˜์™€ ๋ฌธ์ž์—ด ๊ฒ€์ฆ](query-params-str-validations.md){.internal-link target=_blank}์—์„œ์™€ ๋งˆ์ฐฌ๊ฐ€์ง€๋กœ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ์™€ ๋ฌธ์ž์—ด ๊ฒ€์ฆ์„ ์„ ์–ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
๊ทธ๋ฆฌ๊ณ  ์ˆซ์ž ๊ฒ€์ฆ ๋˜ํ•œ ์„ ์–ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค:
* `gt`: ํฌ๊ฑฐ๋‚˜(`g`reater `t`han)
* `ge`: ํฌ๊ฑฐ๋‚˜ ๊ฐ™์€(`g`reater than or `e`qual)
* `lt`: ์ž‘๊ฑฐ๋‚˜(`l`ess `t`han)
* `le`: ์ž‘๊ฑฐ๋‚˜ ๊ฐ™์€(`l`ess than or `e`qual)
!!! info "์ •๋ณด"
`Query`, `Path`, ๊ทธ๋ฆฌ๊ณ  ๋‚˜์ค‘์—๊ฒŒ ๋ณด๊ฒŒ๋  ๊ฒƒ๋“ค์€ (์—ฌ๋Ÿฌ๋ถ„์ด ์‚ฌ์šฉํ•  ํ•„์š”๊ฐ€ ์—†๋Š”) ๊ณตํ†ต `Param` ํด๋ž˜์Šค์˜ ์„œ๋ธŒ ํด๋ž˜์Šค์ž…๋‹ˆ๋‹ค.
๊ทธ๋ฆฌ๊ณ  ์ด๋“ค ๋ชจ๋‘๋Š” ์—ฌํƒœ๊นŒ์ง€ ๋ณธ ์ถ”๊ฐ€ ๊ฒ€์ฆ๊ณผ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ์˜ ๋™์ผํ•œ ๋ชจ๋“  ๋งค๊ฐœ๋ณ€์ˆ˜๋ฅผ ๊ณต์œ ํ•ฉ๋‹ˆ๋‹ค.
!!! note "๊ธฐ์ˆ  ์„ธ๋ถ€์‚ฌํ•ญ"
`fastapi`์—์„œ `Query`, `Path` ๋“ฑ์„ ์ž„ํฌํŠธ ํ•  ๋•Œ, ์ด๊ฒƒ๋“ค์€ ์‹ค์ œ๋กœ ํ•จ์ˆ˜์ž…๋‹ˆ๋‹ค.
ํ˜ธ์ถœ๋˜๋ฉด ๋™์ผํ•œ ์ด๋ฆ„์˜ ํด๋ž˜์Šค์˜ ์ธ์Šคํ„ด์Šค๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.
์ฆ‰, ํ•จ์ˆ˜์ธ `Query`๋ฅผ ์ž„ํฌํŠธํ•œ ๊ฒ๋‹ˆ๋‹ค. ๊ทธ๋ฆฌ๊ณ  ํ˜ธ์ถœํ•˜๋ฉด `Query`๋ผ๋Š” ์ด๋ฆ„์„ ๊ฐ€์ง„ ํด๋ž˜์Šค์˜ ์ธ์Šคํ„ด์Šค๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.
ํŽธ์ง‘๊ธฐ์—์„œ ํƒ€์ž…์— ๋Œ€ํ•œ ์˜ค๋ฅ˜๋ฅผ ํ‘œ์‹œํ•˜์ง€ ์•Š๋„๋ก ํ•˜๊ธฐ ์œ„ํ•ด (ํด๋ž˜์Šค๋ฅผ ์ง์ ‘ ์‚ฌ์šฉํ•˜๋Š” ๋Œ€์‹ ) ์ด๋Ÿฌํ•œ ํ•จ์ˆ˜๋“ค์ด ์žˆ์Šต๋‹ˆ๋‹ค.
์ด๋ ‡๊ฒŒ ํ•˜๋ฉด ์˜ค๋ฅ˜๋ฅผ ๋ฌด์‹œํ•˜๊ธฐ ์œ„ํ•œ ์‚ฌ์šฉ์ž ์„ค์ •์„ ์ถ”๊ฐ€ํ•˜์ง€ ์•Š๊ณ ๋„ ์ผ๋ฐ˜ ํŽธ์ง‘๊ธฐ์™€ ์ฝ”๋”ฉ ๋„๊ตฌ๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

1
docs/ko/mkdocs.yml

@ -61,6 +61,7 @@ nav:
- tutorial/path-params.md
- tutorial/query-params.md
- tutorial/header-params.md
- tutorial/path-params-numeric-validations.md
markdown_extensions:
- toc:
permalink: true

Loadingโ€ฆ
Cancel
Save