mirror of
https://github.com/fastapi/fastapi.git
synced 2026-10-17 23:52:41 -04:00
📝 Update includes for docs/en/docs/tutorial/schema-extra-example.md (#12822)
This commit is contained in:
Sebastián Ramírez authored and GitHub committed
1 parent
636171ce31
commit
5c080d81ae
5 files changed
+25
-577
No files matched your search
@@ -8,35 +8,15 @@
|
||||
|
||||
생성된 JSON 스키마에 추가될 Pydantic 모델을 위한 `examples`을 선언할 수 있습니다.
|
||||
|
||||
//// tab | Python 3.10+ Pydantic v2
|
||||
//// tab | Pydantic v2
|
||||
|
||||
```Python hl_lines="13-24"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial001_py310.py!}
|
||||
```
|
||||
{* ../../docs_src/schema_extra_example/tutorial001_py310.py hl[13:24] *}
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.10+ Pydantic v1
|
||||
//// tab | Pydantic v1
|
||||
|
||||
```Python hl_lines="13-23"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial001_py310_pv1.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.8+ Pydantic v2
|
||||
|
||||
```Python hl_lines="15-26"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial001.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.8+ Pydantic v1
|
||||
|
||||
```Python hl_lines="15-25"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial001_pv1.py!}
|
||||
```
|
||||
{* ../../docs_src/schema_extra_example/tutorial001_pv1_py310.py hl[13:23] *}
|
||||
|
||||
////
|
||||
|
||||
@@ -80,21 +60,7 @@ JSON 스키마를 확장하고 여러분의 별도의 자체 데이터를 추가
|
||||
|
||||
Pydantic 모델과 같이 `Field()`를 사용할 때 추가적인 `examples`를 선언할 수 있습니다:
|
||||
|
||||
//// tab | Python 3.10+
|
||||
|
||||
```Python hl_lines="2 8-11"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial002_py310.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.8+
|
||||
|
||||
```Python hl_lines="4 10-13"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial002.py!}
|
||||
```
|
||||
|
||||
////
|
||||
{* ../../docs_src/schema_extra_example/tutorial002_py310.py hl[2,8:11] *}
|
||||
|
||||
## JSON Schema에서의 `examples` - OpenAPI
|
||||
|
||||
@@ -114,57 +80,7 @@ Pydantic 모델과 같이 `Field()`를 사용할 때 추가적인 `examples`를
|
||||
|
||||
여기, `Body()`에 예상되는 예제 데이터 하나를 포함한 `examples`를 넘겼습니다:
|
||||
|
||||
//// tab | Python 3.10+
|
||||
|
||||
```Python hl_lines="22-29"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial003_an_py310.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.9+
|
||||
|
||||
```Python hl_lines="22-29"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial003_an_py39.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.8+
|
||||
|
||||
```Python hl_lines="23-30"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial003_an.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.10+ Annotated가 없는 경우
|
||||
|
||||
/// tip | "팁"
|
||||
|
||||
가능하다면 `Annotated`가 달린 버전을 권장합니다.
|
||||
|
||||
///
|
||||
|
||||
```Python hl_lines="18-25"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial003_py310.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.8+ Annotated가 없는 경우
|
||||
|
||||
/// tip | "팁"
|
||||
|
||||
가능하다면 `Annotated`가 달린 버전을 권장합니다.
|
||||
|
||||
///
|
||||
|
||||
```Python hl_lines="20-27"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial003.py!}
|
||||
```
|
||||
|
||||
////
|
||||
{* ../../docs_src/schema_extra_example/tutorial003_an_py310.py hl[22:29] *}
|
||||
|
||||
### 문서 UI 예시
|
||||
|
||||
@@ -176,57 +92,7 @@ Pydantic 모델과 같이 `Field()`를 사용할 때 추가적인 `examples`를
|
||||
|
||||
물론 여러 `examples`를 넘길 수 있습니다:
|
||||
|
||||
//// tab | Python 3.10+
|
||||
|
||||
```Python hl_lines="23-38"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial004_an_py310.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.9+
|
||||
|
||||
```Python hl_lines="23-38"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial004_an_py39.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.8+
|
||||
|
||||
```Python hl_lines="24-39"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial004_an.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.10+ Annotated가 없는 경우
|
||||
|
||||
/// tip | "팁"
|
||||
|
||||
가능하다면 `Annotated`가 달린 버전을 권장합니다.
|
||||
|
||||
///
|
||||
|
||||
```Python hl_lines="19-34"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial004_py310.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.8+ Annotated가 없는 경우
|
||||
|
||||
/// tip | "팁"
|
||||
|
||||
가능하다면 `Annotated`가 달린 버전을 권장합니다.
|
||||
|
||||
///
|
||||
|
||||
```Python hl_lines="21-36"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial004.py!}
|
||||
```
|
||||
|
||||
////
|
||||
{* ../../docs_src/schema_extra_example/tutorial004_an_py310.py hl[23:38] *}
|
||||
|
||||
이와 같이 하면 이 예제는 그 본문 데이터를 위한 내부 **JSON 스키마**의 일부가 될 것입니다.
|
||||
|
||||
@@ -267,57 +133,7 @@ Pydantic 모델과 같이 `Field()`를 사용할 때 추가적인 `examples`를
|
||||
|
||||
이를 다음과 같이 사용할 수 있습니다:
|
||||
|
||||
//// tab | Python 3.10+
|
||||
|
||||
```Python hl_lines="23-49"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial005_an_py310.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.9+
|
||||
|
||||
```Python hl_lines="23-49"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial005_an_py39.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.8+
|
||||
|
||||
```Python hl_lines="24-50"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial005_an.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.10+ Annotated가 없는 경우
|
||||
|
||||
/// tip | "팁"
|
||||
|
||||
가능하다면 `Annotated`가 달린 버전을 권장합니다.
|
||||
|
||||
///
|
||||
|
||||
```Python hl_lines="19-45"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial005_py310.py!}
|
||||
```
|
||||
|
||||
////
|
||||
|
||||
//// tab | Python 3.8+ Annotated가 없는 경우
|
||||
|
||||
/// tip | "팁"
|
||||
|
||||
가능하다면 `Annotated`가 달린 버전을 권장합니다.
|
||||
|
||||
///
|
||||
|
||||
```Python hl_lines="21-47"
|
||||
{!> ../../docs_src/schema_extra_example/tutorial005.py!}
|
||||
```
|
||||
|
||||
////
|
||||
{* ../../docs_src/schema_extra_example/tutorial005_an_py310.py hl[23:49] *}
|
||||
|
||||
### 문서 UI에서의 OpenAPI 예시
|
||||
|
||||
|
||||
Reference in new issue
Block a user