@ -177,7 +177,7 @@ Mit **FastAPI** bekommen Sie viele von **Starlette**'s Funktionen (da FastAPI nu
## Pydantic's Merkmale
**FastAPI** ist vollkommen kompatibel (und basiert auf) <ahref="https://pydantic-docs.helpmanual.io"class="external-link"target="_blank"><strong>Pydantic</strong></a>. Das bedeutet, auch jeder zusätzliche Pydantic Quellcode funktioniert.
**FastAPI** ist vollkommen kompatibel (und basiert auf) <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank"><strong>Pydantic</strong></a>. Das bedeutet, auch jeder zusätzliche Pydantic Quellcode funktioniert.
Verfügbar sind ebenso externe auf Pydantic basierende Bibliotheken, wie <abbrtitle="Object-Relational Mapper (Abbildung von Objekten auf relationale Strukturen)">ORM</abbr>s, <abbrtitle="Object-Document Mapper (Abbildung von Objekten auf nicht-relationale Strukturen)">ODM</abbr>s für Datenbanken.
@ -192,7 +192,7 @@ Wiederum, nur mit dieser Deklaration erhalten Sie von **FastAPI**:
Abgesehen von normalen einfachen Typen, wie `str`, `int`, `float`, usw. können Sie komplexere einfache Typen verwenden, die von `str` erben.
Um alle Optionen kennenzulernen, die Sie haben, schauen Sie sich <ahref="https://pydantic-docs.helpmanual.io/usage/types/"class="external-link"target="_blank">Pydantics Typübersicht</a> an. Sie werden im nächsten Kapitel ein paar Beispiele kennenlernen.
Um alle Optionen kennenzulernen, die Sie haben, schauen Sie sich <ahref="https://docs.pydantic.dev/latest/concepts/types/"class="external-link"target="_blank">Pydantics Typübersicht</a> an. Sie werden im nächsten Kapitel ein paar Beispiele kennenlernen.
Da wir zum Beispiel im `Image`-Modell ein Feld `url` haben, können wir deklarieren, dass das eine Instanz von Pydantics `HttpUrl` sein soll, anstelle eines `str`:
@ -6,7 +6,7 @@ Ein **Request**body sind Daten, die vom Client zu Ihrer API gesendet werden. Ein
Ihre API sendet fast immer einen **Response**body. Aber Clients senden nicht unbedingt immer **Request**bodys (sondern nur Metadaten).
Um einen **Request**body zu deklarieren, verwenden Sie <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>-Modelle mit allen deren Fähigkeiten und Vorzügen.
Um einen **Request**body zu deklarieren, verwenden Sie <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a>-Modelle mit allen deren Fähigkeiten und Vorzügen.
!!! info
Um Daten zu versenden, sollten Sie eines von: `POST` (meistverwendet), `PUT`, `DELETE` oder `PATCH` verwenden.
@ -8,7 +8,7 @@ But FastAPI also supports using <a href="https://docs.python.org/3/library/datac
{!../../../docs_src/dataclasses/tutorial001.py!}
```
This is still supported thanks to **Pydantic**, as it has <ahref="https://pydantic-docs.helpmanual.io/usage/dataclasses/#use-of-stdlib-dataclasses-with-basemodel"class="external-link"target="_blank">internal support for `dataclasses`</a>.
This is still supported thanks to **Pydantic**, as it has <ahref="https://docs.pydantic.dev/latest/concepts/dataclasses/#use-of-stdlib-dataclasses-with-basemodel"class="external-link"target="_blank">internal support for `dataclasses`</a>.
So, even with the code above that doesn't use Pydantic explicitly, FastAPI is using Pydantic to convert those standard dataclasses to Pydantic's own flavor of dataclasses.
@ -91,7 +91,7 @@ Check the in-code annotation tips above to see more specific details.
You can also combine `dataclasses` with other Pydantic models, inherit from them, include them in your own models, etc.
To learn more, check the <ahref="https://pydantic-docs.helpmanual.io/usage/dataclasses/"class="external-link"target="_blank">Pydantic docs about dataclasses</a>.
To learn more, check the <ahref="https://docs.pydantic.dev/latest/concepts/dataclasses/"class="external-link"target="_blank">Pydantic docs about dataclasses</a>.
@ -36,7 +36,7 @@ This part is pretty normal, most of the code is probably already familiar to you
```
!!! tip
The `callback_url` query parameter uses a Pydantic <ahref="https://pydantic-docs.helpmanual.io/usage/types/#urls"class="external-link"target="_blank">URL</a> type.
The `callback_url` query parameter uses a Pydantic <ahref="https://docs.pydantic.dev/latest/concepts/types/#urls"class="external-link"target="_blank">URL</a> type.
The only new thing is the `callbacks=invoices_callback_router.routes` as an argument to the *path operation decorator*. We'll see what that is next.
@ -179,7 +179,7 @@ With **FastAPI** you get all of **Starlette**'s features (as FastAPI is just Sta
## Pydantic features
**FastAPI** is fully compatible with (and based on) <ahref="https://pydantic-docs.helpmanual.io"class="external-link"target="_blank"><strong>Pydantic</strong></a>. So, any additional Pydantic code you have, will also work.
**FastAPI** is fully compatible with (and based on) <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank"><strong>Pydantic</strong></a>. So, any additional Pydantic code you have, will also work.
Including external libraries also based on Pydantic, as <abbrtitle="Object-Relational Mapper">ORM</abbr>s, <abbrtitle="Object-Document Mapper">ODM</abbr>s for databases.
@ -54,7 +54,7 @@ All in a way that provided the best development experience for all the developer
## Requirements
After testing several alternatives, I decided that I was going to use <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">**Pydantic**</a> for its advantages.
After testing several alternatives, I decided that I was going to use <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">**Pydantic**</a> for its advantages.
Then I contributed to it, to make it fully compliant with JSON Schema, to support different ways to define constraint declarations, and to improve editor support (type checks, autocompletion) based on the tests in several editors.
@ -434,7 +434,7 @@ It doesn't mean "`one_person` is the **class** called `Person`".
## Pydantic models
<ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a> is a Python library to perform data validation.
<ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a> is a Python library to perform data validation.
You declare the "shape" of the data as classes with attributes.
@ -465,14 +465,14 @@ An example from the official Pydantic docs:
```
!!! info
To learn more about <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic, check its docs</a>.
To learn more about <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic, check its docs</a>.
**FastAPI** is all based on Pydantic.
You will see a lot more of all this in practice in the [Tutorial - User Guide](tutorial/index.md){.internal-link target=_blank}.
!!! tip
Pydantic has a special behavior when you use `Optional` or `Union[Something, None]` without a default value, you can read more about it in the Pydantic docs about <ahref="https://pydantic-docs.helpmanual.io/usage/models/#required-optional-fields"class="external-link"target="_blank">Required Optional fields</a>.
Pydantic has a special behavior when you use `Optional` or `Union[Something, None]` without a default value, you can read more about it in the Pydantic docs about <ahref="https://docs.pydantic.dev/latest/concepts/models/#required-optional-fields"class="external-link"target="_blank">Required Optional fields</a>.
@ -3486,7 +3486,7 @@ Note: all the previous parameters are still there, so it's still possible to dec
* Upgrade Pydantic supported version to `0.29.0`.
* New supported version range is `"pydantic >=0.28,<=0.29.0"`.
* This adds support for Pydantic [Generic Models](https://pydantic-docs.helpmanual.io/#generic-models), kudos to [@dmontagu](https://github.com/dmontagu).
* This adds support for Pydantic [Generic Models](https://docs.pydantic.dev/latest/#generic-models), kudos to [@dmontagu](https://github.com/dmontagu).
@ -192,7 +192,7 @@ Again, doing just that declaration, with **FastAPI** you get:
Apart from normal singular types like `str`, `int`, `float`, etc. you can use more complex singular types that inherit from `str`.
To see all the options you have, checkout the docs for <ahref="https://pydantic-docs.helpmanual.io/usage/types/"class="external-link"target="_blank">Pydantic's exotic types</a>. You will see some examples in the next chapter.
To see all the options you have, checkout the docs for <ahref="https://docs.pydantic.dev/latest/concepts/types/"class="external-link"target="_blank">Pydantic's exotic types</a>. You will see some examples in the next chapter.
For example, as in the `Image` model we have a `url` field, we can declare it to be an instance of Pydantic's `HttpUrl` instead of a `str`:
@ -6,7 +6,7 @@ A **request** body is data sent by the client to your API. A **response** body i
Your API almost always has to send a **response** body. But clients don't necessarily need to send **request** bodies all the time.
To declare a **request** body, you use <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a> models with all their power and benefits.
To declare a **request** body, you use <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a> models with all their power and benefits.
!!! info
To send data, you should use one of: `POST` (the more common), `PUT`, `DELETE` or `PATCH`.
@ -36,7 +36,7 @@ Here are some of the additional data types you can use:
* `datetime.timedelta`:
* A Python `datetime.timedelta`.
* In requests and responses will be represented as a `float` of total seconds.
* Pydantic also allows representing it as a "ISO 8601 time diff encoding", <ahref="https://pydantic-docs.helpmanual.io/usage/exporting_models/#json_encoders"class="external-link"target="_blank">see the docs for more info</a>.
* Pydantic also allows representing it as a "ISO 8601 time diff encoding", <ahref="https://docs.pydantic.dev/latest/concepts/serialization/#json_encoders"class="external-link"target="_blank">see the docs for more info</a>.
* `frozenset`:
* In requests and responses, treated the same as a `set`:
* In requests, a list will be read, eliminating duplicates and converting it to a `set`.
@ -184,7 +184,7 @@ It will be defined in OpenAPI with `anyOf`.
To do that, use the standard Python type hint <ahref="https://docs.python.org/3/library/typing.html#typing.Union"class="external-link"target="_blank">`typing.Union`</a>:
!!! note
When defining a <ahref="https://pydantic-docs.helpmanual.io/usage/types/#unions"class="external-link"target="_blank">`Union`</a>, include the most specific type first, followed by the less specific type. In the example below, the more specific `PlaneItem` comes before `CarItem` in `Union[PlaneItem, CarItem]`.
When defining a <ahref="https://docs.pydantic.dev/latest/concepts/types/#unions"class="external-link"target="_blank">`Union`</a>, include the most specific type first, followed by the less specific type. In the example below, the more specific `PlaneItem` comes before `CarItem` in `Union[PlaneItem, CarItem]`.
These are technical details that you might skip if it's not important for you now.
`RequestValidationError` is a sub-class of Pydantic's <ahref="https://pydantic-docs.helpmanual.io/usage/models/#error-handling"class="external-link"target="_blank">`ValidationError`</a>.
`RequestValidationError` is a sub-class of Pydantic's <ahref="https://docs.pydantic.dev/latest/concepts/models/#error-handling"class="external-link"target="_blank">`ValidationError`</a>.
**FastAPI** uses it so that, if you use a Pydantic model in `response_model`, and your data has an error, you will see the error in your log.
@ -95,7 +95,7 @@ The same way, there are many compatible tools. Including code generation tools f
## Pydantic
All the data validation is performed under the hood by <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>, so you get all the benefits from it. And you know you are in good hands.
All the data validation is performed under the hood by <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a>, so you get all the benefits from it. And you know you are in good hands.
You can use the same type declarations with `str`, `float`, `bool` and many other complex data types.
@ -500,7 +500,7 @@ To do that, you can declare that `None` is a valid type but still use `...` as t
```
!!! tip
Pydantic, which is what powers all the data validation and serialization in FastAPI, has a special behavior when you use `Optional` or `Union[Something, None]` without a default value, you can read more about it in the Pydantic docs about <ahref="https://pydantic-docs.helpmanual.io/usage/models/#required-optional-fields"class="external-link"target="_blank">Required Optional fields</a>.
Pydantic, which is what powers all the data validation and serialization in FastAPI, has a special behavior when you use `Optional` or `Union[Something, None]` without a default value, you can read more about it in the Pydantic docs about <ahref="https://docs.pydantic.dev/latest/concepts/models/#required-optional-fields"class="external-link"target="_blank">Required Optional fields</a>.
!!! tip
Remember that in most of the cases, when something is required, you can simply omit the default, so you normally don't have to use `...`.
@ -383,7 +383,7 @@ So, if you send a request to that *path operation* for the item with ID `foo`, t
The examples here use `.dict()` for compatibility with Pydantic v1, but you should use `.model_dump()` instead if you can use Pydantic v2.
!!! info
FastAPI uses Pydantic model's `.dict()` with <ahref="https://pydantic-docs.helpmanual.io/usage/exporting_models/#modeldict"class="external-link"target="_blank">its `exclude_unset` parameter</a> to achieve this.
FastAPI uses Pydantic model's `.dict()` with <ahref="https://docs.pydantic.dev/latest/concepts/serialization/#modeldict"class="external-link"target="_blank">its `exclude_unset` parameter</a> to achieve this.
!!! info
You can also use:
@ -391,7 +391,7 @@ So, if you send a request to that *path operation* for the item with ID `foo`, t
* `response_model_exclude_defaults=True`
* `response_model_exclude_none=True`
as described in <ahref="https://pydantic-docs.helpmanual.io/usage/exporting_models/#modeldict"class="external-link"target="_blank">the Pydantic docs</a> for `exclude_defaults` and `exclude_none`.
as described in <ahref="https://docs.pydantic.dev/latest/concepts/serialization/#modeldict"class="external-link"target="_blank">the Pydantic docs</a> for `exclude_defaults` and `exclude_none`.
@ -338,7 +338,7 @@ Not only the IDs of those items, but all the data that we defined in the Pydanti
Now, in the Pydantic *models* for reading, `Item` and `User`, add an internal `Config` class.
This <ahref="https://pydantic-docs.helpmanual.io/usage/model_config/"class="external-link"target="_blank">`Config`</a> class is used to provide configurations to Pydantic.
This <ahref="https://docs.pydantic.dev/latest/api/config/"class="external-link"target="_blank">`Config`</a> class is used to provide configurations to Pydantic.
In the `Config` class, set the attribute `orm_mode = True`.
@ -179,7 +179,7 @@ Con **FastAPI** obtienes todas las características de **Starlette** (porque Fas
## Características de Pydantic
**FastAPI** está basado y es completamente compatible con <ahref="https://pydantic-docs.helpmanual.io"class="external-link"target="_blank"><strong>Pydantic</strong></a>. Tanto así, que cualquier código de Pydantic que tengas también funcionará.
**FastAPI** está basado y es completamente compatible con <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank"><strong>Pydantic</strong></a>. Tanto así, que cualquier código de Pydantic que tengas también funcionará.
Esto incluye a librerías externas basadas en Pydantic como <abbrtitle="Object-Relational Mapper">ORM</abbr>s y <abbrtitle="Object-Document Mapper">ODM</abbr>s para bases de datos.
@ -237,7 +237,7 @@ Una vez más tendrás todo el soporte del editor:
## Modelos de Pydantic
<ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a> es una library de Python para llevar a cabo validación de datos.
<ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a> es una library de Python para llevar a cabo validación de datos.
Tú declaras la "forma" de los datos mediante clases con atributos.
@ -254,7 +254,7 @@ Tomado de la documentación oficial de Pydantic:
```
!!! info "Información"
Para aprender más sobre <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic mira su documentación</a>.
Para aprender más sobre <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic mira su documentación</a>.
@ -93,7 +93,7 @@ De la misma manera hay muchas herramientas compatibles. Incluyendo herramientas
## Pydantic
Toda la validación de datos es realizada tras bastidores por <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>, así que obtienes todos sus beneficios. Así sabes que estás en buenas manos.
Toda la validación de datos es realizada tras bastidores por <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a>, así que obtienes todos sus beneficios. Así sabes que estás en buenas manos.
Puedes usar las mismas declaraciones de tipos con `str`, `float`, `bool` y otros tipos de datos más complejos.
@ -182,7 +182,7 @@ FastAPI شامل یک سیستم <abbr title='همچنین به عنوان "comp
## ویژگی های Pydantic
**FastAPI** کاملا (و براساس) با <ahref="https://pydantic-docs.helpmanual.io"class="external-link"target="_blank"><strong>Pydantic</strong></a> سازگار است. بنابراین هرکد Pydantic اضافی که داشته باشید، نیز کار خواهد کرد.
**FastAPI** کاملا (و براساس) با <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank"><strong>Pydantic</strong></a> سازگار است. بنابراین هرکد Pydantic اضافی که داشته باشید، نیز کار خواهد کرد.
از جمله کتابخانه های خارجی نیز مبتنی بر Pydantic میتوان به <abbrtitle="Object-Relational Mapper">ORM</abbr> و <abbrtitle="Object-Document Mapper">ODM</abbr> ها برای دیتابیس ها اشاره کرد.
Pydantic est une bibliothèque permettant de définir la validation, la sérialisation et la documentation des données (à l'aide de JSON Schema) en se basant sur les Python type hints.
@ -174,7 +174,7 @@ Avec **FastAPI** vous aurez toutes les fonctionnalités de **Starlette** (FastAP
## Fonctionnalités de Pydantic
**FastAPI** est totalement compatible avec (et basé sur) <ahref="https://pydantic-docs.helpmanual.io"class="external-link"target="_blank"><strong>Pydantic</strong></a>. Le code utilisant Pydantic que vous ajouterez fonctionnera donc aussi.
**FastAPI** est totalement compatible avec (et basé sur) <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank"><strong>Pydantic</strong></a>. Le code utilisant Pydantic que vous ajouterez fonctionnera donc aussi.
Inclus des librairies externes basées, aussi, sur Pydantic, servent d'<abbrtitle="Object-Relational Mapper">ORM</abbr>s, <abbrtitle="Object-Document Mapper">ODM</abbr>s pour les bases de données.
@ -54,7 +54,7 @@ Le tout de manière à offrir la meilleure expérience de développement à tous
## Exigences
Après avoir testé plusieurs alternatives, j'ai décidé que j'allais utiliser <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">**Pydantic**</a> pour ses avantages.
Après avoir testé plusieurs alternatives, j'ai décidé que j'allais utiliser <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">**Pydantic**</a> pour ses avantages.
J'y ai ensuite contribué, pour le rendre entièrement compatible avec JSON Schema, pour supporter différentes manières de définir les déclarations de contraintes, et pour améliorer le support des éditeurs (vérifications de type, autocomplétion) sur la base des tests effectués dans plusieurs éditeurs.
@ -265,7 +265,7 @@ Et vous aurez accès, encore une fois, au support complet offert par l'éditeur
## Les modèles Pydantic
<ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a> est une bibliothèque Python pour effectuer de la validation de données.
<ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a> est une bibliothèque Python pour effectuer de la validation de données.
Vous déclarez la forme de la donnée avec des classes et des attributs.
@ -282,7 +282,7 @@ Extrait de la documentation officielle de **Pydantic** :
```
!!! info
Pour en savoir plus à propos de <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic, allez jeter un coup d'oeil à sa documentation</a>.
Pour en savoir plus à propos de <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic, allez jeter un coup d'oeil à sa documentation</a>.
**FastAPI** est basé entièrement sur **Pydantic**.
@ -6,7 +6,7 @@ Le corps d'une **requête** est de la donnée envoyée par le client à votre AP
Votre API aura presque toujours à envoyer un corps de **réponse**. Mais un client n'a pas toujours à envoyer un corps de **requête**.
Pour déclarer un corps de **requête**, on utilise les modèles de <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a> en profitant de tous leurs avantages et fonctionnalités.
Pour déclarer un corps de **requête**, on utilise les modèles de <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a> en profitant de tous leurs avantages et fonctionnalités.
!!! info
Pour envoyer de la donnée, vous devriez utiliser : `POST` (le plus populaire), `PUT`, `DELETE` ou `PATCH`.
Toute la validation de données est effectué en arrière-plan avec <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>,
Toute la validation de données est effectué en arrière-plan avec <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a>,
dont vous bénéficierez de tous les avantages. Vous savez donc que vous êtes entre de bonnes mains.
@ -179,7 +179,7 @@ FastAPI는 사용하기 매우 간편하지만, 엄청난 <abbr title='"컴포
## Pydantic 기능
**FastAPI**는 <ahref="https://pydantic-docs.helpmanual.io"class="external-link"target="_blank"><strong>Pydantic</strong></a>을 기반으로 하며 Pydantic과 완벽하게 호환됩니다. 그래서 어느 추가적인 Pydantic 코드를 여러분이 가지고 있든 작동할 것입니다.
**FastAPI**는 <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank"><strong>Pydantic</strong></a>을 기반으로 하며 Pydantic과 완벽하게 호환됩니다. 그래서 어느 추가적인 Pydantic 코드를 여러분이 가지고 있든 작동할 것입니다.
Pydantic을 기반으로 하는, 데이터베이스를 위한 <abbrtitle="Object-Relational Mapper">ORM</abbr>, <abbrtitle="Object-Document Mapper">ODM</abbr>을 포함한 외부 라이브러리를 포함합니다.
@ -117,7 +117,7 @@ Pydantic 모델의 각 어트리뷰트는 타입을 갖습니다.
`str`, `int`, `float` 등과 같은 단일 타입과는 별개로, `str`을 상속하는 더 복잡한 단일 타입을 사용할 수 있습니다.
모든 옵션을 보려면, <ahref="https://pydantic-docs.helpmanual.io/usage/types/"class="external-link"target="_blank">Pydantic's exotic types</a> 문서를 확인하세요. 다음 장에서 몇가지 예제를 볼 수 있습니다.
모든 옵션을 보려면, <ahref="https://docs.pydantic.dev/latest/concepts/types/"class="external-link"target="_blank">Pydantic's exotic types</a> 문서를 확인하세요. 다음 장에서 몇가지 예제를 볼 수 있습니다.
예를 들어 `Image` 모델 안에 `url` 필드를 `str` 대신 Pydantic의 `HttpUrl`로 선언할 수 있습니다:
모든 데이터 검증은 <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>에 의해 내부적으로 수행되므로 이로 인한 이점을 모두 얻을 수 있습니다. 여러분은 관리를 잘 받고 있음을 느낄 수 있습니다.
모든 데이터 검증은 <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a>에 의해 내부적으로 수행되므로 이로 인한 이점을 모두 얻을 수 있습니다. 여러분은 관리를 잘 받고 있음을 느낄 수 있습니다.
`str`, `float`, `bool`, 그리고 다른 여러 복잡한 데이터 타입 선언을 할 수 있습니다.
@ -122,7 +122,7 @@ FastAPI는 이 `response_model`를 사용하여:
```
!!! info "정보"
FastAPI는 이를 위해 Pydantic 모델의 `.dict()`의 <ahref="https://pydantic-docs.helpmanual.io/usage/exporting_models/#modeldict"class="external-link"target="_blank">`exclude_unset` 매개변수</a>를 사용합니다.
FastAPI는 이를 위해 Pydantic 모델의 `.dict()`의 <ahref="https://docs.pydantic.dev/latest/concepts/serialization/#modeldict"class="external-link"target="_blank">`exclude_unset` 매개변수</a>를 사용합니다.
!!! info "정보"
아래 또한 사용할 수 있습니다:
@ -130,7 +130,7 @@ FastAPI는 이 `response_model`를 사용하여:
* `response_model_exclude_defaults=True`
* `response_model_exclude_none=True`
<ahref="https://pydantic-docs.helpmanual.io/usage/exporting_models/#modeldict"class="external-link"target="_blank">Pydantic 문서</a>에서 `exclude_defaults` 및 `exclude_none`에 대해 설명한 대로 사용할 수 있습니다.
<ahref="https://docs.pydantic.dev/latest/concepts/serialization/#modeldict"class="external-link"target="_blank">Pydantic 문서</a>에서 `exclude_defaults` 및 `exclude_none`에 대해 설명한 대로 사용할 수 있습니다.
@ -174,7 +174,7 @@ Dzięki **FastAPI** otrzymujesz wszystkie funkcje **Starlette** (ponieważ FastA
## Cechy Pydantic
**FastAPI** jest w pełni kompatybilny z (oraz bazuje na) <ahref="https://pydantic-docs.helpmanual.io"class="external-link"target="_blank"><strong>Pydantic</strong></a>. Tak więc każdy dodatkowy kod Pydantic, który posiadasz, również będzie działał.
**FastAPI** jest w pełni kompatybilny z (oraz bazuje na) <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank"><strong>Pydantic</strong></a>. Tak więc każdy dodatkowy kod Pydantic, który posiadasz, również będzie działał.
Wliczając w to zewnętrzne biblioteki, również oparte o Pydantic, takie jak <abbrtitle="Mapowanie obiektowo-relacyjne. Po angielsku: Object-Relational Mapper">ORM</abbr>, <abbrtitle="Object-Document Mapper">ODM</abbr> dla baz danych.
@ -175,7 +175,7 @@ Com **FastAPI**, você terá todos os recursos do **Starlette** (já que FastAPI
## Recursos do Pydantic
**FastAPI** é totalmente compatível com (e baseado no) <ahref="https://pydantic-docs.helpmanual.io"class="external-link"target="_blank"><strong>Pydantic</strong></a>. Então, qualquer código Pydantic adicional que você tiver, também funcionará.
**FastAPI** é totalmente compatível com (e baseado no) <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank"><strong>Pydantic</strong></a>. Então, qualquer código Pydantic adicional que você tiver, também funcionará.
Incluindo bibliotecas externas também baseadas no Pydantic, como <abbrtitle="Object-Relational Mapper">ORM</abbr>s e <abbrtitle="Object-Document Mapper">ODM</abbr>s para bancos de dados.
@ -54,7 +54,7 @@ Tudo de uma forma que oferecesse a melhor experiência de desenvolvimento para t
## Requisitos
Após testar várias alternativas, eu decidi que usaria o <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">**Pydantic**</a> por suas vantagens.
Após testar várias alternativas, eu decidi que usaria o <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">**Pydantic**</a> por suas vantagens.
Então eu contribuí com ele, para deixá-lo completamente de acordo com o JSON Schema, para dar suporte a diferentes maneiras de definir declarações de restrições, e melhorar o suporte a editores (conferências de tipos, auto completações) baseado nos testes em vários editores.
@ -266,7 +266,7 @@ E então, novamente, você recebe todo o suporte do editor:
## Modelos Pydantic
<ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank"> Pydantic </a> é uma biblioteca Python para executar a validação de dados.
<ahref="https://docs.pydantic.dev/"class="external-link"target="_blank"> Pydantic </a> é uma biblioteca Python para executar a validação de dados.
Você declara a "forma" dos dados como classes com atributos.
@ -283,7 +283,7 @@ Retirado dos documentos oficiais dos Pydantic:
```
!!! info "Informação"
Para saber mais sobre o <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank"> Pydantic, verifique seus documentos </a>.
Para saber mais sobre o <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank"> Pydantic, verifique seus documentos </a>.
@ -121,7 +121,7 @@ Novamente, apenas fazendo essa declaração, com o **FastAPI**, você ganha:
Além dos tipos singulares normais como `str`, `int`, `float`, etc. Você também pode usar tipos singulares mais complexos que herdam de `str`.
Para ver todas as opções possíveis, cheque a documentação para os<ahref="https://pydantic-docs.helpmanual.io/usage/types/"class="external-link"target="_blank">tipos exoticos do Pydantic</a>. Você verá alguns exemplos no próximo capitulo.
Para ver todas as opções possíveis, cheque a documentação para os<ahref="https://docs.pydantic.dev/latest/concepts/types/"class="external-link"target="_blank">tipos exoticos do Pydantic</a>. Você verá alguns exemplos no próximo capitulo.
Por exemplo, no modelo `Image` nós temos um campo `url`, nós podemos declara-lo como um `HttpUrl` do Pydantic invés de como uma `str`:
@ -6,7 +6,7 @@ O corpo da **requisição** é a informação enviada pelo cliente para sua API.
Sua API quase sempre irá enviar um corpo na **resposta**. Mas os clientes não necessariamente precisam enviar um corpo em toda **requisição**.
Para declarar um corpo da **requisição**, você utiliza os modelos do <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a> com todos os seus poderes e benefícios.
Para declarar um corpo da **requisição**, você utiliza os modelos do <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a> com todos os seus poderes e benefícios.
!!! info "Informação"
Para enviar dados, você deve usar utilizar um dos métodos: `POST` (Mais comum), `PUT`, `DELETE` ou `PATCH`.
@ -36,7 +36,7 @@ Aqui estão alguns dos tipos de dados adicionais que você pode usar:
* `datetime.timedelta`:
* O `datetime.timedelta` do Python.
* Em requisições e respostas será representado como um `float` de segundos totais.
* O Pydantic também permite representá-lo como uma "codificação ISO 8601 diferença de tempo", <ahref="https://pydantic-docs.helpmanual.io/#json-serialisation"class="external-link"target="_blank">cheque a documentação para mais informações</a>.
* O Pydantic também permite representá-lo como uma "codificação ISO 8601 diferença de tempo", <ahref="https://docs.pydantic.dev/latest/concepts/serialization/"class="external-link"target="_blank">cheque a documentação para mais informações</a>.
* `frozenset`:
* Em requisições e respostas, será tratado da mesma forma que um `set`:
* Nas requisições, uma lista será lida, eliminando duplicadas e convertendo-a em um `set`.
@ -49,7 +49,7 @@ Aqui estão alguns dos tipos de dados adicionais que você pode usar:
* `Decimal`:
* O `Decimal` padrão do Python.
* Em requisições e respostas será representado como um `float`.
* Você pode checar todos os tipos de dados válidos do Pydantic aqui: <ahref="https://pydantic-docs.helpmanual.io/usage/types"class="external-link"target="_blank">Tipos de dados do Pydantic</a>.
* Você pode checar todos os tipos de dados válidos do Pydantic aqui: <ahref="https://docs.pydantic.dev/latest/concepts/types/"class="external-link"target="_blank">Tipos de dados do Pydantic</a>.
@ -179,7 +179,7 @@ Isso será definido no OpenAPI com `anyOf`.
Para fazer isso, use a dica de tipo padrão do Python <ahref="https://docs.python.org/3/library/typing.html#typing.Union"class="external-link"target="_blank">`typing.Union`</a>:
!!! note
Ao definir um <ahref="https://pydantic-docs.helpmanual.io/usage/types/#unions"class="external-link"target="_blank">`Union`</a>, inclua o tipo mais específico primeiro, seguido pelo tipo menos específico. No exemplo abaixo, o tipo mais específico `PlaneItem` vem antes de `CarItem` em `Union[PlaneItem, CarItem]`.
Ao definir um <ahref="https://docs.pydantic.dev/latest/concepts/types/#unions"class="external-link"target="_blank">`Union`</a>, inclua o tipo mais específico primeiro, seguido pelo tipo menos específico. No exemplo abaixo, o tipo mais específico `PlaneItem` vem antes de `CarItem` em `Union[PlaneItem, CarItem]`.
Você pode pular estes detalhes técnicos caso eles não sejam importantes para você neste momento.
`RequestValidationError` é uma subclasse do <ahref="https://pydantic-docs.helpmanual.io/#error-handling"class="external-link"target="_blank">`ValidationError`</a> existente no Pydantic.
`RequestValidationError` é uma subclasse do <ahref="https://docs.pydantic.dev/latest/#error-handling"class="external-link"target="_blank">`ValidationError`</a> existente no Pydantic.
**FastAPI** faz uso dele para que você veja o erro no seu log, caso você utilize um modelo de Pydantic em `response_model`, e seus dados tenham erro.
@ -93,7 +93,7 @@ Da mesma forma, existem muitas ferramentas compatíveis. Incluindo ferramentas d
## Pydantic
Toda a validação de dados é feita por baixo dos panos pelo <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>, então você tem todos os benefícios disso. E assim você sabe que está em boas mãos.
Toda a validação de dados é feita por baixo dos panos pelo <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a>, então você tem todos os benefícios disso. E assim você sabe que está em boas mãos.
Você pode usar as mesmas declarações de tipo com `str`, `float`, `bool` e muitos outros tipos complexos de dados.
@ -6,7 +6,7 @@ Aqui estão várias formas de se fazer isso.
## `schema_extra` do Pydantic
Você pode declarar um `example` para um modelo Pydantic usando `Config` e `schema_extra`, conforme descrito em <ahref="https://pydantic-docs.helpmanual.io/usage/schema/#schema-customization"class="external-link"target="_blank">Documentação do Pydantic: Schema customization</a>:
Você pode declarar um `example` para um modelo Pydantic usando `Config` e `schema_extra`, conforme descrito em <ahref="https://docs.pydantic.dev/latest/concepts/json_schema/#schema-customization"class="external-link"target="_blank">Documentação do Pydantic: Schema customization</a>:
Pydantic - это библиотека для валидации данных, сериализации и документирования (используя JSON Schema), основываясь на подсказках типов Python, что делает его чрезвычайно интуитивным.
@ -177,7 +177,7 @@ FastAPI включает в себя чрезвычайно простую в и
## Особенности и возможности Pydantic
**FastAPI** основан на <ahref="https://pydantic-docs.helpmanual.io"class="external-link"target="_blank"><strong>Pydantic</strong></a> и полностью совместим с ним. Так что, любой дополнительный код Pydantic, который у вас есть, будет также работать.
**FastAPI** основан на <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank"><strong>Pydantic</strong></a> и полностью совместим с ним. Так что, любой дополнительный код Pydantic, который у вас есть, будет также работать.
Включая внешние библиотеки, также основанные на Pydantic, такие как: <abbrtitle="Object-Relational Mapper">ORM'ы</abbr>, <abbrtitle="Object-Document Mapper">ODM'ы</abbr> для баз данных.
Протестировав несколько вариантов, я решил, что в качестве основы буду использовать <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">**Pydantic**</a> и его преимущества.
Протестировав несколько вариантов, я решил, что в качестве основы буду использовать <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">**Pydantic**</a> и его преимущества.
По моим предложениям был изменён код этого фреймворка, чтобы сделать его полностью совместимым с JSON Schema, поддержать различные способы определения ограничений и улучшить помощь редакторов (проверки типов, автозаполнение).
<ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a> является Python-библиотекой для выполнения валидации данных.
<ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a> является Python-библиотекой для выполнения валидации данных.
Вы объявляете «форму» данных как классы с атрибутами.
@ -282,7 +282,7 @@ John Doe
```
!!! info
Чтобы узнать больше о <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic, читайте его документацию</a>.
Чтобы узнать больше о <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic, читайте его документацию</a>.
Помимо обычных простых типов, таких как `str`, `int`, `float`, и т.д. Вы можете использовать более сложные базовые типы, которые наследуются от типа `str`.
Чтобы увидеть все варианты, которые у вас есть, ознакомьтесь с документацией <ahref="https://pydantic-docs.helpmanual.io/usage/types/"class="external-link"target="_blank">по необычным типам Pydantic</a>. Вы увидите некоторые примеры в следующей главе.
Чтобы увидеть все варианты, которые у вас есть, ознакомьтесь с документацией <ahref="https://docs.pydantic.dev/latest/concepts/types/"class="external-link"target="_blank">по необычным типам Pydantic</a>. Вы увидите некоторые примеры в следующей главе.
Например, так как в модели `Image` у нас есть поле `url`, то мы можем объявить его как тип `HttpUrl` из модуля Pydantic вместо типа `str`:
Ваш API почти всегда отправляет тело **ответа**. Но клиентам не обязательно всегда отправлять тело **запроса**.
Чтобы объявить тело **запроса**, необходимо использовать модели <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>, со всей их мощью и преимуществами.
Чтобы объявить тело **запроса**, необходимо использовать модели <ahref="https://docs.pydantic.dev/"class="external-link"target="_blank">Pydantic</a>, со всей их мощью и преимуществами.
!!! info "Информация"
Чтобы отправить данные, необходимо использовать один из методов: `POST` (обычно), `PUT`, `DELETE` или `PATCH`.
* В запросах и ответах будет представлен в виде общего количества секунд типа `float`.
* Pydantic также позволяет представить его как "Кодировку разницы во времени ISO 8601", <ahref="https://pydantic-docs.helpmanual.io/usage/exporting_models/#json_encoders"class="external-link"target="_blank">см. документацию для получения дополнительной информации</a>.
* Pydantic также позволяет представить его как "Кодировку разницы во времени ISO 8601", <ahref="https://docs.pydantic.dev/latest/concepts/serialization/#json_encoders"class="external-link"target="_blank">см. документацию для получения дополнительной информации</a>.
* `frozenset`:
* В запросах и ответах обрабатывается так же, как и `set`:
* В запросах будет прочитан список, исключены дубликаты и преобразован в `set`.
@ -49,7 +49,7 @@
* `Decimal`:
* Встроенный в Python `Decimal`.
* В запросах и ответах обрабатывается так же, как и `float`.
* Вы можете проверить все допустимые типы данных pydantic здесь: <ahref="https://pydantic-docs.helpmanual.io/usage/types"class="external-link"target="_blank">Типы данных Pydantic</a>.
* Вы можете проверить все допустимые типы данных pydantic здесь: <ahref="https://docs.pydantic.dev/latest/concepts/types/"class="external-link"target="_blank">Типы данных Pydantic</a>.
Для этого используйте стандартные аннотации типов в Python <ahref="https://docs.python.org/3/library/typing.html#typing.Union"class="external-link"target="_blank">`typing.Union`</a>:
!!! note "Примечание"
При объявлении <ahref="https://pydantic-docs.helpmanual.io/usage/types/#unions"class="external-link"target="_blank">`Union`</a>, сначала указывайте наиболее детальные типы, затем менее детальные. В примере ниже более детальный `PlaneItem` стоит перед `CarItem` в `Union[PlaneItem, CarItem]`.
При объявлении <ahref="https://docs.pydantic.dev/latest/concepts/types/#unions"class="external-link"target="_blank">`Union`</a>, сначала указывайте наиболее детальные типы, затем менее детальные. В примере ниже более детальный `PlaneItem` стоит перед `CarItem` в `Union[PlaneItem, CarItem]`.
Это технические детали, которые можно пропустить, если они не важны для вас сейчас.
`RequestValidationError` является подклассом Pydantic <ahref="https://pydantic-docs.helpmanual.io/usage/models/#error-handling"class="external-link"target="_blank">`ValidationError`</a>.
`RequestValidationError` является подклассом Pydantic <ahref="https://docs.pydantic.dev/latest/concepts/models/#error-handling"class="external-link"target="_blank">`ValidationError`</a>.
**FastAPI** использует его для того, чтобы, если вы используете Pydantic-модель в `response_model`, и ваши данные содержат ошибку, вы увидели ошибку в журнале.
Some files were not shown because too many files changed in this diff
Alejandra
1 year ago
GitHub