Introduction à Fastapi : Les bases de FastAPI

https://fastapi.tiangolo.com/

Dans cet article, nous allons nous familiariser avec les bases de FastAPI. Nous verrons comment installer FastAPI, définir un schéma OpenAPI et utiliser les paramètres de chemin d’accès et de requête.

Qu’est-ce que FastAPI ?

FastAPI est un framework Python moderne pour créer des API REST. Il est rapide, facile à utiliser et offre de nombreuses fonctionnalités avancées.

Pourquoi utiliser FastAPI ?

FastAPI offre de nombreux avantages, notamment :

• Performances élevées : FastAPI est un framework hautes performances, capable de gérer des millions de requêtes par seconde.
• Facilité d’utilisation : FastAPI est un framework facile à apprendre et à utiliser, même pour les développeurs débutants.
• Fonctionnalités avancées : FastAPI offre de nombreuses fonctionnalités avancées, telles que la validation des données, la documentation automatique et la sécurité.

Installation de FastAPI

Pour installer FastAPI, nous avons besoin de Python 3.8 ou supérieur. Nous pouvons installer FastAPI avec pip en exécutant la commande suivante :

pip install fastapi

Définir un schéma OpenAPI

Un schéma OpenAPI est un document qui décrit l’interface d’une API. Il est utilisé pour générer la documentation de l’API, ainsi que pour tester et automatiser les interactions avec l’API.

Pour définir un schéma OpenAPI avec FastAPI, nous pouvons utiliser la fonction OpenAPI(). Cette fonction prend en entrée un objet APIRouter qui représente l'API.

Voici un exemple de schéma OpenAPI simple :

from fastapi import FastAPI

app = FastAPI(
    title="My API",
    version="1.0.0",
    description="This is a simple API."
)

@app.get("/")
def read_root():
    return {"Hello": "World"}

Ce schéma définit une API avec une seule route, /, qui retourne le message "Hello, world!".

Paramètres de chemin d’accès et de requête

FastAPI permet de définir des paramètres de chemin d’accès et de requête pour les routes de l’API. Les paramètres de chemin d’accès sont utilisés pour identifier la ressource à laquelle la requête est adressée. Les paramètres de requête sont utilisés pour transmettre des informations supplémentaires à l’API.

Pour définir un paramètre de chemin d’accès, nous pouvons utiliser la fonction path(). Cette fonction prend en entrée le nom du paramètre et son type.

Voici un exemple de route avec un paramètre de chemin d’accès :

from fastapi import FastAPI

app = FastAPI()

@app.get("/users/{user_id}")
def get_user(user_id: int):
    return {"user_id": user_id}

Cette route retourne les informations sur l’utilisateur dont l’identifiant est donné par le paramètre user_id.

Pour définir un paramètre de requête, nous pouvons utiliser la fonction query(). Cette fonction prend en entrée le nom du paramètre et son type.

Voici un exemple de route avec un paramètre de requête :

from fastapi import FastAPI

app = FastAPI()

@app.get("/users")
def get_users(page_size: int = 10, page_number: int = 1):
    return {
        "users": [
            {"user_id": 1},
            {"user_id": 2},
            {"user_id": 3},
        ]
    }

Cette route retourne la liste des utilisateurs, avec un nombre limité d’utilisateurs par page. Le nombre d’utilisateurs par page est donné par le paramètre page_size. Le numéro de la page est donné par le paramètre page_number.

Conclusion

Dans cette introduction, nous avons vu les bases de FastAPI. Nous avons vu comment installer FastAPI, définir un schéma OpenAPI et utiliser les paramètres de chemin d’accès et de requête.

Dans les prochains articles, nous verrons comment créer des API REST plus complexes avec FastAPI.