* le contenu d'un fichier sur le disque soit lu par le système et passé à votre programme
* le contenu que votre programme a passé au système soit écrit sur le disque
* une opération effectuée à distance par une API se termine
* une opération en BDD se termine
* une requête à une BDD renvoie un résultat
* etc.

* <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank"><strong>Swagger UI</strong></a>, propose une documentation interactive. Vous permet de directement tester l'API depuis votre navigateur.

![Swagger UI interaction](https://fastapi.tiangolo.com/img/index/index-03-swagger-02.png)

{* ../../docs_src/first_steps/tutorial001.py hl[7] *}

C'est une fonction Python.

Elle sera appelée par **FastAPI** quand une requête sur l'URL `/` sera reçue via une opération `GET`.

Ici, c'est une fonction asynchrone (définie avec `async def`).

---

Vous pourriez aussi la définir comme une fonction classique plutôt qu'avec `async def` :

Puis j'ai découvert qu'il existait une norme pour documenter les API, en utilisant JSON (ou YAML, une extension de JSON) appelée Swagger.

Il existait déjà une interface utilisateur Web pour les API Swagger. Donc, être capable de générer une documentation
Swagger pour une API permettrait d'utiliser cette interface utilisateur web automatiquement.

### Classes en tant que types

Vous pouvez aussi déclarer une classe comme type d'une variable.

Disons que vous avez une classe `Person`, avec une variable `name` :

{*../../docs_src/python_types/tutorial010.py hl[1:3] *}


Vous pouvez ensuite déclarer une variable de type `Person` :

{*../../docs_src/python_types/tutorial010.py hl[6] *}

Et vous aurez accès, encore une fois, au support complet offert par l'éditeur :

/// info

À nouveau, en utilisant uniquement les déclarations de type Python, **FastAPI** vous fournit automatiquement une documentation interactive (via Swagger UI).

On voit bien dans la documentation que `item_id` est déclaré comme entier.

///

## Les avantages d'avoir une documentation basée sur une norme, et la documentation alternative.

constraints.Future.message = {item} doit être une valeur future.
constraints.Max.message = {item} doit être inférieur ou égal à {value}.
constraints.Min.message = {item} doit être supérieur ou égal à {value}.
constraints.NotNull.message = {item} est requis.
constraints.Null.message = {item} doit être nul.
constraints.Past.message = {item} doit être une valeur passée.

![ReDoc](https://fastapi.tiangolo.com/img/index/index-06-redoc-02.png)

### En résumé

En résumé, vous déclarez **une fois** les types de paramètres, <abbr title="en anglais : body">le corps</abbr>  de la requête, etc. en tant que paramètres de fonction.

Vous faites cela avec les types Python standard modernes.

Vous n'avez pas à apprendre une nouvelle syntaxe, les méthodes ou les classes d'une bibliothèque spécifique, etc.

Juste du **Python** standard.

labels.permissions=Autorisations
labels.virtual_hosts=Hôtes virtuels
labels.virtual_host=Hôte virtuel
labels.label_type=Étiquette
labels.file_crawling_button_create=Créer
labels.file_crawling_button_create_job=Créer une nouvelle tâche
labels.web_crawling_configuration=Exploration Web
labels.web_crawling_title_details=Configuration de l'exploration Web
labels.included_urls=URL incluses
labels.excluded_urls=URL exclues

Llamar a este programa genera:

```
John Doe
```

La función hace lo siguiente:

* Toma un `first_name` y `last_name`.
* Convierte la primera letra de cada uno a mayúsculas con `title()`.
* <abbr title="Los une, como uno. Con el contenido de uno después del otro.">Concatena</abbr> ambos con un espacio en el medio.

{* ../../docs_src/python_types/tutorial001.py hl[2] *}

### Edítalo

Es un programa muy simple.