Skip to content

Commit 2cb1374

Browse files
kantandanes-rigaud
authored andcommitted
📝 Update includes in docs/fr/docs/advanced/path-operation-advanced-configuration.md (fastapi#12633)
1 parent 4789fa3 commit 2cb1374

File tree

1 file changed

+8
-24
lines changed

1 file changed

+8
-24
lines changed

‎docs/fr/docs/advanced/path-operation-advanced-configuration.md

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,15 @@ Dans OpenAPI, les chemins sont des ressources, tels que /users/ ou /items/, expo
1212

1313
Vous devez vous assurer qu'il est unique pour chaque opération.
1414

15-
```Python hl_lines="6"
16-
{!../../docs_src/path_operation_advanced_configuration/tutorial001.py!}
17-
```
15+
{* ../../docs_src/path_operation_advanced_configuration/tutorial001.py hl[6] *}
1816

1917
### Utilisation du nom *path operation function* comme operationId
2018

2119
Si vous souhaitez utiliser les noms de fonction de vos API comme `operationId`, vous pouvez les parcourir tous et remplacer chaque `operation_id` de l'*opération de chemin* en utilisant leur `APIRoute.name`.
2220

2321
Vous devriez le faire après avoir ajouté toutes vos *paramètres de chemin*.
2422

25-
```Python hl_lines="2 12-21 24"
26-
{!../../docs_src/path_operation_advanced_configuration/tutorial002.py!}
27-
```
23+
{* ../../docs_src/path_operation_advanced_configuration/tutorial002.py hl[2,12:21,24] *}
2824

2925
/// tip | "Astuce"
3026

@@ -44,9 +40,7 @@ Même s'ils se trouvent dans des modules différents (fichiers Python).
4440

4541
Pour exclure un *chemin* du schéma OpenAPI généré (et donc des systèmes de documentation automatiques), utilisez le paramètre `include_in_schema` et assignez-lui la valeur `False` :
4642

47-
```Python hl_lines="6"
48-
{!../../docs_src/path_operation_advanced_configuration/tutorial003.py!}
49-
```
43+
{* ../../docs_src/path_operation_advanced_configuration/tutorial003.py hl[6] *}
5044

5145
## Description avancée de docstring
5246

@@ -56,9 +50,7 @@ L'ajout d'un `\f` (un caractère d'échappement "form feed") va permettre à **F
5650

5751
Il n'apparaîtra pas dans la documentation, mais d'autres outils (tel que Sphinx) pourront utiliser le reste.
5852

59-
```Python hl_lines="19-29"
60-
{!../../docs_src/path_operation_advanced_configuration/tutorial004.py!}
61-
```
53+
{* ../../docs_src/path_operation_advanced_configuration/tutorial004.py hl[19:29] *}
6254

6355
## Réponses supplémentaires
6456

@@ -98,9 +90,7 @@ Vous pouvez étendre le schéma OpenAPI pour une *opération de chemin* en utili
9890

9991
Cet `openapi_extra` peut être utile, par exemple, pour déclarer [OpenAPI Extensions](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specificationExtensions) :
10092

101-
```Python hl_lines="6"
102-
{!../../docs_src/path_operation_advanced_configuration/tutorial005.py!}
103-
```
93+
{* ../../docs_src/path_operation_advanced_configuration/tutorial005.py hl[6] *}
10494

10595
Si vous ouvrez la documentation automatique de l'API, votre extension apparaîtra au bas du *chemin* spécifique.
10696

@@ -147,9 +137,7 @@ Par exemple, vous pouvez décider de lire et de valider la requête avec votre p
147137

148138
Vous pouvez le faire avec `openapi_extra` :
149139

150-
```Python hl_lines="20-37 39-40"
151-
{!../../docs_src/path_operation_advanced_configuration/tutorial006.py !}
152-
```
140+
{* ../../docs_src/path_operation_advanced_configuration/tutorial006.py hl[20:37,39:40] *}
153141

154142
Dans cet exemple, nous n'avons déclaré aucun modèle Pydantic. En fait, le corps de la requête n'est même pas <abbr title="converti d'un format simple, comme des octets, en objets Python">parsé</abbr> en tant que JSON, il est lu directement en tant que `bytes`, et la fonction `magic_data_reader()` serait chargé de l'analyser d'une manière ou d'une autre.
155143

@@ -163,19 +151,15 @@ Et vous pouvez le faire même si le type de données dans la requête n'est pas
163151

164152
Dans cet exemple, nous n'utilisons pas les fonctionnalités de FastAPI pour extraire le schéma JSON des modèles Pydantic ni la validation automatique pour JSON. En fait, nous déclarons le type de contenu de la requête en tant que YAML, et non JSON :
165153

166-
```Python hl_lines="17-22 24"
167-
{!../../docs_src/path_operation_advanced_configuration/tutorial007.py!}
168-
```
154+
{* ../../docs_src/path_operation_advanced_configuration/tutorial007.py hl[17:22,24] *}
169155

170156
Néanmoins, bien que nous n'utilisions pas la fonctionnalité par défaut, nous utilisons toujours un modèle Pydantic pour générer manuellement le schéma JSON pour les données que nous souhaitons recevoir en YAML.
171157

172158
Ensuite, nous utilisons directement la requĂŞte et extrayons son contenu en tant qu'octets. Cela signifie que FastAPI n'essaiera mĂŞme pas d'analyser le payload de la requĂŞte en tant que JSON.
173159

174160
Et nous analysons directement ce contenu YAML, puis nous utilisons à nouveau le même modèle Pydantic pour valider le contenu YAML :
175161

176-
```Python hl_lines="26-33"
177-
{!../../docs_src/path_operation_advanced_configuration/tutorial007.py!}
178-
```
162+
{* ../../docs_src/path_operation_advanced_configuration/tutorial007.py hl[26:33] *}
179163

180164
/// tip | "Astuce"
181165

0 commit comments

Comments
 (0)