]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commitdiff
🌐 Add Korean translation for `docs/tutorial/response-status-code.md` (#3742)
authorNina Hwang <79563565+NinaHwang@users.noreply.github.com>
Wed, 8 Dec 2021 15:45:37 +0000 (00:45 +0900)
committerGitHub <noreply@github.com>
Wed, 8 Dec 2021 15:45:37 +0000 (16:45 +0100)
Co-authored-by: weekwith.me <63915557+0417taehyun@users.noreply.github.com>
Co-authored-by: SebastiΓ‘n RamΓ­rez <tiangolo@gmail.com>
docs/ko/docs/tutorial/response-status-code.md [new file with mode: 0644]
docs/ko/mkdocs.yml

diff --git a/docs/ko/docs/tutorial/response-status-code.md b/docs/ko/docs/tutorial/response-status-code.md
new file mode 100644 (file)
index 0000000..d201867
--- /dev/null
@@ -0,0 +1,89 @@
+# μ‘λ‹΅ μƒνƒœ μ½”λ“œ
+
+응닡 λͺ¨λΈκ³Ό κ°™μ€ λ°©λ²•μœΌλ‘œ, μ–΄λ–€ *경둜 μž‘동*이든 `status_code` λ§€κ°œλ³€μˆ˜λ₯Ό μ‚¬μš©ν•˜μ—¬ μ‘닡에 λŒ€ν•œ HTTP μƒνƒœ μ½”λ“œλ₯Ό μ„ μ–Έν•  μˆ˜ μžˆμŠ΅λ‹ˆλ‹€.
+
+* `@app.get()`
+* `@app.post()`
+* `@app.put()`
+* `@app.delete()`
+* κΈ°νƒ€
+
+```Python hl_lines="6" 
+{!../../../docs_src/response_status_code/tutorial001.py!}
+```
+
+!!! note "μ°Έκ³ " 
+    `status_code` λŠ” "λ°μ½”λ ˆμ΄ν„°" λ©”μ†Œλ“œ(`get`, `post` λ“±)의 λ§€κ°œλ³€μˆ˜μž…λ‹ˆλ‹€. λͺ¨λ“  λ§€κ°œλ³€μˆ˜λ“€κ³Ό λ³Έλ¬Έμ²˜λŸΌ *경둜 μž‘동 ν•¨μˆ˜*κ°€ μ•„λ‹™λ‹ˆλ‹€.
+
+`status_code` λ§€κ°œλ³€μˆ˜λŠ” HTTP μƒνƒœ μ½”λ“œλ₯Ό μˆ«μžλ‘œ μž…λ ₯λ°›μŠ΅λ‹ˆλ‹€.
+
+!!! info "정보"
+    `status_code` λŠ” νŒŒμ΄μ¬μ˜ `http.HTTPStatus` μ™€ κ°™μ€ `IntEnum` μ„ μž…λ ₯받을 μˆ˜λ„ μžˆμŠ΅λ‹ˆλ‹€.
+
+`status_code` λ§€κ°œλ³€μˆ˜λŠ”:
+
+* μ‘λ‹΅μ—μ„œ ν•΄λ‹Ή μƒνƒœ μ½”λ“œλ₯Ό λ°˜ν™˜ν•©λ‹ˆλ‹€.
+* μƒνƒœ μ½”λ“œλ₯Ό OpenAPI μŠ€ν‚€λ§ˆ(및 μ‚¬μš©μž μΈν„°νŽ˜μ΄μŠ€)에 λ¬Έμ„œν™” ν•©λ‹ˆλ‹€.
+
+<img src="https://fastapi.tiangolo.com/img/tutorial/response-status-code/image01.png">
+
+!!! note "μ°Έκ³ " 
+    μ–΄λ–€ μ‘λ‹΅ μ½”λ“œλ“€μ€ ν•΄λ‹Ή μ‘닡에 λ³Έλ¬Έμ΄ μ—†λ‹€λŠ” κ²ƒμ„ μ˜λ―Έν•˜κΈ°λ„ ν•©λ‹ˆλ‹€ (λ‹€μŒ ν•­λͺ© μ°Έκ³ ).
+
+    μ΄μ— λ”°λΌ FastAPIλŠ” μ‘λ‹΅ λ³Έλ¬Έμ΄ μ—†μŒμ„ λͺ…μ‹œν•˜λŠ” OpenAPIλ₯Ό μƒμ„±ν•©λ‹ˆλ‹€.
+
+## HTTP μƒνƒœ μ½”λ“œμ— λŒ€ν•˜μ—¬
+
+!!! note "μ°Έκ³ "
+    λ§Œμ•½ HTTP μƒνƒœ μ½”λ“œμ— λŒ€ν•˜μ—¬ μ΄λ―Έ μ•Œκ³ μžˆλ‹€λ©΄, λ‹€μŒ ν•­λͺ©μœΌλ‘œ λ„˜μ–΄κ°€μ‹­μ‹œμ˜€.
+
+HTTPλŠ” μ„Έμžλ¦¬μ˜ μˆ«μž μƒνƒœ μ½”λ“œλ₯Ό μ‘λ‹΅μ˜ μΌλΆ€λ‘œ μ „μ†‘ν•©λ‹ˆλ‹€.
+
+이 μƒνƒœ μ½”λ“œλ“€μ€ κ°μžλ₯Ό μ‹λ³„ν•  μˆ˜ μžˆλ„둝 μ§€μ •λœ μ΄λ¦„이 μžˆμœΌλ‚˜, μ€‘μš”ν•œ κ²ƒμ€ μˆ«μž μ½”λ“œμž…λ‹ˆλ‹€.
+
+μš”μ•½ν•˜μžλ©΄:
+
+* `**1xx**` μƒνƒœ μ½”λ“œλŠ” "정보"μš©μž…λ‹ˆλ‹€. μ΄λ“€μ€ μ§μ ‘μ μœΌλ‘œλŠ” μž˜ μ‚¬μš©λ˜μ§€λŠ” μ•ŠμŠ΅λ‹ˆλ‹€. μ΄ μƒνƒœ μ½”λ“œλ₯Ό κ°–λŠ” μ‘닡듀은 λ³Έλ¬Έμ„ κ°€μ§ˆ μˆ˜ μ—†μŠ΅λ‹ˆλ‹€.
+* `**2xx**` μƒνƒœ μ½”λ“œλŠ” "성곡적인" μ‘닡을 μœ„ν•΄ μ‚¬μš©λ©λ‹ˆλ‹€. κ°€μž₯ λ§Žμ΄ μ‚¬μš©λ˜λŠ” μœ ν˜•μž…λ‹ˆλ‹€.
+    * `200` μ€ λ””ν΄νŠΈ μƒνƒœ μ½”λ“œλ‘œ, λͺ¨λ“  κ²ƒμ΄ "μ„±κ³΅μ μž„"을 μ˜λ―Έν•©λ‹ˆλ‹€.
+    * λ‹€λ₯Έ μ˜ˆλ‘œλŠ” `201` "생성됨"이 μžˆμŠ΅λ‹ˆλ‹€. μΌλ°˜μ μœΌλ‘œ λ°μ΄ν„°λ² μ΄μŠ€μ— μƒˆλ‘œμš΄ λ ˆμ½”λ“œλ₯Ό μƒμ„±ν•œ ν›„ μ‚¬μš©ν•©λ‹ˆλ‹€.
+    * λ‹¨, `204` "λ‚΄μš© μ—†μŒ"은 νŠΉλ³„ν•œ κ²½μš°μž…λ‹ˆλ‹€. μ΄κ²ƒμ€ ν΄λΌμ΄μ–ΈνŠΈμ—κ²Œ λ°˜ν™˜ν•  λ‚΄μš©μ΄ μ—†λŠ” κ²½μš° μ‚¬μš©ν•©λ‹ˆλ‹€. λ”°λΌμ„œ μ‘닡은 λ³Έλ¬Έμ„ κ°€μ§ˆ μˆ˜ μ—†μŠ΅λ‹ˆλ‹€.
+* `**3xx**` μƒνƒœ μ½”λ“œλŠ” "λ¦¬λ‹€μ΄λ ‰μ…˜"μš©μž…λ‹ˆλ‹€. λ³Έλ¬Έμ„ κ°€μ§ˆ μˆ˜ μ—†λŠ” `304` "μˆ˜μ •λ˜μ§€ μ•ŠμŒ"을 μ œμ™Έν•˜κ³ , μ΄ μƒνƒœ μ½”λ“œλ₯Ό κ°–λŠ” μ‘λ‹΅μ—λŠ” λ³Έλ¬Έμ΄ μžˆμ„ μˆ˜λ„, μ—†μ„ μˆ˜λ„ μžˆμŠ΅λ‹ˆλ‹€.
+* `**4xx**` μƒνƒœ μ½”λ“œλŠ” "ν΄λΌμ΄μ–ΈνŠΈ μ˜€λ₯˜" μ‘닡을 μœ„ν•΄ μ‚¬μš©λ©λ‹ˆλ‹€. μ΄κ²ƒμ€ μ•„λ§ˆ κ°€μž₯ λ§Žμ΄ μ‚¬μš©ν•˜κ²Œ λ  λ‘λ²ˆμ§Έ μœ ν˜•μž…λ‹ˆλ‹€.
+    * μΌλ‘€λ‘œ `404` λŠ” "찾을 μˆ˜ μ—†μŒ" μ‘닡을 μœ„ν•΄ μ‚¬μš©ν•©λ‹ˆλ‹€.
+    * μΌλ°˜μ μΈ ν΄λΌμ΄μ–ΈνŠΈ μ˜€λ₯˜μ˜ κ²½μš° `400` μ„ μ‚¬μš©ν•  μˆ˜ μžˆμŠ΅λ‹ˆλ‹€.
+* `**5xx**` μƒνƒœ μ½”λ“œλŠ” μ„œλ²„ μ˜€λ₯˜μ— μ‚¬μš©λ©λ‹ˆλ‹€. μ΄κ²ƒλ“€μ„ μ§μ ‘ μ‚¬μš©ν•  μΌμ€ κ±°μ˜ μ—†μŠ΅λ‹ˆλ‹€. μ‘μš© ν”„λ‘œκ·Έλž¨ μ½”λ“œλ‚˜ μ„œλ²„μ˜ μΌλΆ€μ—μ„œ λ¬Έμ œκ°€ λ°œμƒν•˜λ©΄ μžλ™μœΌλ‘œ μ΄λ“€ μƒνƒœ μ½”λ“œ μ€‘ ν•˜λ‚˜λ₯Ό λ°˜ν™˜ν•©λ‹ˆλ‹€.
+
+!!! tip "팁"
+    κ°κ°μ˜ μƒνƒœ μ½”λ“œμ™€ μ΄λ“€μ΄ μ˜λ―Έν•˜λŠ” λ‚΄μš©μ— λŒ€ν•΄ λ” μ•Œκ³ μ‹Άλ‹€λ©΄ <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" class="external-link" target="_blank"><abbr title="Mozilla Developer Network">MDN</abbr> HTTP μƒνƒœ μ½”λ“œμ— κ΄€ν•œ λ¬Έμ„œ</a> λ₯Ό ν™•μΈν•˜μ‹­μ‹œμ˜€.
+
+## μ΄λ¦„을 κΈ°μ–΅ν•˜λŠ” μ‰¬μš΄ λ°©λ²•
+
+상기 μ˜ˆμ‹œ μ°Έκ³ :
+
+```Python hl_lines="6" 
+{!../../../docs_src/response_status_code/tutorial001.py!}
+```
+
+`201` μ€ "생성됨"λ₯Ό μ˜λ―Έν•˜λŠ” μƒνƒœ μ½”λ“œμž…λ‹ˆλ‹€.
+
+ν•˜μ§€λ§Œ λͺ¨λ“  μƒνƒœ μ½”λ“œλ“€μ΄ λ¬΄μ—‡μ„ μ˜λ―Έν•˜λŠ”μ§€ μ™ΈμšΈ ν•„μš”λŠ” μ—†μŠ΅λ‹ˆλ‹€.
+
+`fastapi.status` μ˜ νŽΈμ˜ λ³€μˆ˜λ₯Ό μ‚¬μš©ν•  μˆ˜ μžˆμŠ΅λ‹ˆλ‹€.
+
+```Python hl_lines="1  6" 
+{!../../../docs_src/response_status_code/tutorial002.py!}
+```
+
+이것은 λ‹¨μˆœνžˆ μž‘업을 νŽΈλ¦¬ν•˜κ²Œ ν•˜κΈ° μœ„ν•œ κ²ƒμœΌλ‘œ, HTTP μƒνƒœ μ½”λ“œμ™€ λ™μΌν•œ λ²ˆν˜Έλ₯Ό κ°–κ³ μžˆμ§€λ§Œ, μ΄λ₯Ό μ‚¬μš©ν•˜λ©΄ νŽΈμ§‘κΈ°μ˜ μžλ™μ™„μ„± κΈ°λŠ₯을 μ‚¬μš©ν•  μˆ˜ μžˆμŠ΅λ‹ˆλ‹€:
+
+<img src="https://fastapi.tiangolo.com/img/tutorial/response-status-code/image02.png">
+
+!!! note "기술적 μ„ΈλΆ€μ‚¬ν•­"
+    `from starlette import status` μ—­μ‹œ μ‚¬μš©ν•  μˆ˜ μžˆμŠ΅λ‹ˆλ‹€.
+
+    **FastAPI**λŠ” κ°œλ°œμžμΈ λ‹Ήμ‹ μ˜ νŽΈμ˜λ₯Ό μœ„ν•΄ `fastapi.status` μ™€ λ™μΌν•œ `starlette.status` λ„ μ œκ³΅ν•©λ‹ˆλ‹€. ν•˜μ§€λ§Œ μ΄κ²ƒμ€ Starletteλ‘œλΆ€ν„° μ§μ ‘ μ œκ³΅λ©λ‹ˆλ‹€.
+
+## κΈ°λ³Έκ°’ λ³€κ²½
+
+μΆ”ν›„ μ—¬κΈ°μ„œ μ„ μ–Έν•˜λŠ” κΈ°λ³Έ μƒνƒœ μ½”λ“œκ°€ μ•„λ‹Œ λ‹€λ₯Έ μƒνƒœ μ½”λ“œλ₯Ό λ°˜ν™˜ν•˜λŠ” λ°©λ²•을 [μˆ™λ ¨λœ μ‚¬μš©μž μ§€μΉ¨μ„œ](https://fastapi.tiangolo.com/ko/advanced/response-change-status-code/){.internal-link target=_blank}μ—μ„œ ν™•인할 μˆ˜ μžˆμŠ΅λ‹ˆλ‹€.
index 0cd0e2f9fd006b10aa7e55e4b1eb66052fcfb849..dd2d6a7ac7ace13f07ef73c6f22a1c8b2bc5e8a3 100644 (file)
@@ -62,6 +62,7 @@ nav:
   - tutorial/query-params.md
   - tutorial/header-params.md
   - tutorial/path-params-numeric-validations.md
+  - tutorial/response-status-code.md
 markdown_extensions:
 - toc:
     permalink: true