Comment Développer Une API Asynchrone Avec FastAPI Et MongoDB

Dans ce tutoriel, vous apprendrez à développer une API asynchrone avec FastAPI et MongoDB . Nous utiliserons la bibliothèque Beanie ODM pour interagir avec MongoDB de manière asynchrone.

Objectifs

À la fin de ce didacticiel, vous serez en mesure de :

1. Expliquez ce qu'est Beanie ODM et pourquoi vous voudrez peut-être l'utiliser
2. Interagissez avec MongoDB de manière asynchrone à l'aide de Beanie ODM
3. Développer une API RESTful avec Python et FastAPI

Pourquoi Beanie ODM ?

Beanie est un mappeur objet-document (ODM) asynchrone pour MongoDB, qui prend en charge les migrations de données et de schémas prêtes à l'emploi. Il utilise Motor , comme moteur de base de données asynchrone, et Pydantic .

Bien que vous puissiez simplement utiliser Motor, Beanie fournit une couche d'abstraction supplémentaire, ce qui facilite grandement l'interaction avec les collections dans une base de données Mongo.

Vous voulez simplement utiliser Motor ? Découvrez Créer une application CRUD avec FastAPI et MongoDB .

La configuration initiale

Commencez par créer un nouveau dossier pour contenir votre projet appelé "fastapi-beanie":

$ mkdir fastapi-beanie
$ cd fastapi-beanie

Ensuite, créez et activez un environnement virtuel :

$ python3.10 -m venv venv
$ source venv/bin/activate
(venv)$ export PYTHONPATH=$PWD

N'hésitez pas à échanger venv et Pip contre Poetry ou Pipenv . Pour en savoir plus, consultez Environnements Python modernes .

Ensuite, créez les fichiers et dossiers suivants :

├── app
│   ├── __init__.py
│   ├── main.py
│   └── server
│       ├── app.py
│       ├── database.py
│       ├── models
│       └── routes
└── requirements.txt

Ajoutez les dépendances suivantes à votre fichier requirements.txt :

beanie==1.11.0
fastapi==0.78.0
uvicorn==0.17.6

Installez les dépendances depuis votre terminal :

(venv)$ pip install -r requirements.txt

Dans le fichier app/main.py , définissez un point d'entrée pour exécuter l'application :

import uvicorn

if __name__ == "__main__":
    uvicorn.run("server.app:app", host="0.0.0.0", port=8000, reload=True)

Ici, nous avons demandé au fichier d'exécuter un serveur Uvicorn sur le port 8000 et de le recharger à chaque modification de fichier.

Avant de démarrer le serveur via le fichier de point d'entrée, créez une route de base dans app/server/app.py :

from fastapi import FastAPI

app = FastAPI()


@app.get("/", tags=["Root"])
async def read_root() -> dict:
    return {"message": "Welcome to your beanie powered app!"}

Exécutez le fichier de point d'entrée depuis votre console :

(venv)$ python app/main.py

Accédez à http://localhost:8000 dans votre navigateur. Tu devrais voir:

{
  "message": "Welcome to your beanie powered app!"
}

Que construisons-nous ?

Nous allons créer une application d'évaluation de produits qui nous permettra d'effectuer les opérations suivantes :

• Créer des avis
• Lire les avis
• Mettre à jour les avis
• Supprimer les avis

Avant de plonger dans l'écriture des routes, utilisons Beanie pour configurer le modèle de base de données pour notre application.

Schéma de base de données

Beanie vous permet de créer des documents qui peuvent ensuite être utilisés pour interagir avec les collections de la base de données. Les documents représentent le schéma de votre base de données. Ils peuvent être définis en créant des classes enfants qui héritent de la Documentclasse de Beanie. La Documentclasse est alimentée par Pydantic's BaseModel, ce qui facilite la définition des collections et du schéma de base de données ainsi que des exemples de données affichés dans la page de documentation interactive de Swagger.

Exemple:

from beanie import Document


class TestDrivenArticle(Document):
    title: str
    content: str
    date: datetime
    author: str

Le document défini représente la façon dont les articles seront stockés dans la base de données. Cependant, il s'agit d'une classe de document normale sans collection de base de données associée. Pour associer une collection, il vous suffit d'ajouter une Settingsclasse en tant que sous-classe :

from beanie import Document


class TestDrivenArticle(Document):
    title: str
    content: str
    date: datetime
    author: str


    class Settings:
        name = "testdriven_collection"

Maintenant que nous avons une idée de la façon dont les schémas sont créés, nous allons créer le schéma de notre application. Dans le dossier "app/server/models", créez un nouveau fichier appelé product_review.py :

from datetime import datetime

from beanie import Document
from pydantic import BaseModel
from typing import Optional


class ProductReview(Document):
    name: str
    product: str
    rating: float
    review: str
    date: datetime = datetime.now()

    class Settings:
        name = "product_review"

Étant donné que la Documentclasse est alimentée par Pydantic, nous pouvons définir des exemples de données de schéma pour faciliter l'utilisation de l'API par les développeurs à partir des documents interactifs Swagger.

Ajoutez la sous- Configclasse comme suit :

from datetime import datetime

from beanie import Document
from pydantic import BaseModel
from typing import Optional


class ProductReview(Document):
    name: str
    product: str
    rating: float
    review: str
    date: datetime = datetime.now()

    class Settings:
        name = "product_review"

    class Config:
        schema_extra = {
            "example": {
                "name": "Abdulazeez",
                "product": "TestDriven TDD Course",
                "rating": 4.9,
                "review": "Excellent course!",
                "date": datetime.now()
            }
        }

Ainsi, dans le bloc de code ci-dessus, nous avons défini un document Beanie appelé ProductReviewqui représente la façon dont une revue de produit sera stockée. Nous avons également défini la collection, product_review, où les données seront stockées.

Nous utiliserons ce schéma dans la route pour appliquer le corps de requête approprié.

Définissons enfin le schéma de mise à jour d'un avis produit :

class UpdateProductReview(BaseModel):
    name: Optional[str]
    product: Optional[str]
    rating: Optional[float]
    review: Optional[str]
    date: Optional[datetime]

    class Config:
        schema_extra = {
            "example": {
                "name": "Abdulazeez Abdulazeez",
                "product": "TestDriven TDD Course",
                "rating": 5.0,
                "review": "Excellent course!",
                "date": datetime.now()
            }
        }

La UpdateProductReviewclasse ci-dessus est de type BaseModel , ce qui nous permet de modifier uniquement les champs présents dans le corps de la requête.

Avec le schéma en place, configurons MongoDB et notre base de données avant de procéder à l'écriture des routes.

MongoDB

Dans cette section, nous allons connecter MongoDB et configurer notre application pour communiquer avec elle.

Selon Wikipedia , MongoDB est un programme de base de données multiplateforme orienté document. Classé comme programme de base de données NoSQL, MongoDB utilise des documents de type JSON avec des schémas facultatifs.

Configuration de MongoDB

Si MongoDB n'est pas installé sur votre machine, reportez-vous au guide d' installation de la documentation. Une fois installé, continuez avec le guide pour exécuter le processus du démon mongod . Une fois cela fait, vous pouvez vérifier que MongoDB est opérationnel en vous connectant à l'instance via la mongocommande shell :

$ mongo

Pour référence, ce tutoriel utilise MongoDB Community Edition v5.0.7.

$ mongo --version
MongoDB shell version v5.0.7

Build Info: {
    "version": "5.0.7",
    "gitVersion": "b977129dc70eed766cbee7e412d901ee213acbda",
    "modules": [],
    "allocator": "system",
    "environment": {
        "distarch": "x86_64",
        "target_arch": "x86_64"
    }
}

Configuration de la base de données

Dans database.py , ajoutez ce qui suit :

from beanie import init_beanie
import motor.motor_asyncio

from app.server.models.product_review import ProductReview


async def init_db():
    client = motor.motor_asyncio.AsyncIOMotorClient(
        "mongodb://localhost:27017/productreviews"
    )

    await init_beanie(database=client.db_name, document_models=[ProductReview])

Dans le bloc de code ci-dessus, nous avons importé la méthode init_beanie qui est responsable de l'initialisation du moteur de base de données alimenté par motor.motor_asyncio . La init_beanieméthode prend deux arguments :

1. database- Le nom de la base de données à utiliser.
2. document_models- Une liste de modèles de documents définis -- le ProductReviewmodèle, dans notre cas.

La init_dbfonction sera invoquée dans l'événement de démarrage de l'application. Mettez à jour app.py pour inclure l'événement de démarrage :

from fastapi import FastAPI

from app.server.database import init_db


app = FastAPI()


@app.on_event("startup")
async def start_db():
    await init_db()


@app.get("/", tags=["Root"])
async def read_root() -> dict:
    return {"message": "Welcome to your beanie powered app!"}

Maintenant que nos configurations de base de données sont en place, écrivons les routes.

Itinéraires

Dans cette section, nous allons construire les routes pour effectuer des opérations CRUD sur votre base de données depuis l'application :

1. Examen APRÈS-VENTE
2. OBTENEZ un avis unique et OBTENEZ tous les avis
3. PUT examen unique
4. SUPPRIMER un seul avis

Dans le dossier "routes", créez un fichier nommé product_review.py :

from beanie import PydanticObjectId
from fastapi import APIRouter, HTTPException
from typing import List

from app.server.models.product_review import ProductReview, UpdateProductReview


router = APIRouter()

Dans le bloc de code ci-dessus, nous avons importé PydanticObjectId, qui sera utilisé pour indiquer le type de l'argument ID lors de la récupération d'une seule requête. Nous avons également importé la APIRouterclasse responsable de la gestion des opérations de routage. Nous avons également importé la classe de modèle que nous avons définie précédemment.

Les modèles de document Beanie nous permettent d'interagir directement avec la base de données avec moins de code. Par exemple, pour récupérer tous les enregistrements d'une collection de base de données, il suffit de :

data = await ProductReview.find_all().to_list()
return data # A list of all records in the collection.

Avant de procéder à l'écriture de la fonction route pour les opérations CRUD, enregistrons la route dans app.py :

from fastapi import FastAPI

from app.server.database import init_db
from app.server.routes.product_review import router as Router


app = FastAPI()
app.include_router(Router, tags=["Product Reviews"], prefix="/reviews")


@app.on_event("startup")
async def start_db():
    await init_db()


@app.get("/", tags=["Root"])
async def read_root() -> dict:
    return {"message": "Welcome to your beanie powered app!"}

Créer

Dans routes/product_review.py , ajoutez ce qui suit :

@router.post("/", response_description="Review added to the database")
async def add_product_review(review: ProductReview) -> dict:
    await review.create()
    return {"message": "Review added successfully"}

Ici, nous avons défini la fonction route, qui prend un argument de type ProductReview. Comme indiqué précédemment, la classe de document peut interagir directement avec la base de données.

Le nouvel enregistrement est créé en appelant la méthode create() .

La route ci-dessus attend une charge utile similaire à celle-ci :

{
  "name": "Abdulazeez",
  "product": "TestDriven TDD Course",
  "rating": 4.9,
  "review": "Excellent course!",
  "date": "2022-05-17T13:53:17.196135"
}

Testez le parcours :

$ curl -X 'POST' \
  'http://0.0.0.0:8000/reviews/' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Abdulazeez",
  "product": "TestDriven TDD Course",
  "rating": 4.9,
  "review": "Excellent course!",
  "date": "2022-05-17T13:53:17.196135"
}'

La requête ci-dessus doit renvoyer un message de réussite :

{
  "message": "Review added successfully"
}

Lis

Viennent ensuite les routes qui nous permettent de récupérer un seul avis et tous les avis présents dans la base de données :

@router.get("/{id}", response_description="Review record retrieved")
async def get_review_record(id: PydanticObjectId) -> ProductReview:
    review = await ProductReview.get(id)
    return review


@router.get("/", response_description="Review records retrieved")
async def get_reviews() -> List[ProductReview]:
    reviews = await ProductReview.find_all().to_list()
    return reviews

Dans le bloc de code ci-dessus, nous avons défini deux fonctions :

1. Dans la première fonction, la fonction prend un ID de type ObjectiD, l'encodage par défaut pour les ID MongoDB. L'enregistrement est récupéré à l'aide de la méthode get() .
2. Dans le second, nous avons récupéré tous les avis à l'aide de la méthode find_all() . La to_list()méthode est ajoutée afin que les résultats soient renvoyés dans une liste.

Une autre méthode qui peut être utilisée pour récupérer une seule entrée est la méthode find_one() qui prend une condition. Par exemple:

# Return a record who has a rating of 4.0
await ProductReview.find_one(ProductReview.rating == 4.0)

Testons la première route pour récupérer tous les enregistrements :

$ curl -X 'GET' \
  'http://0.0.0.0:8000/reviews/' \
  -H 'accept: application/json'

Réponse:

[
  {
    "_id": "62839ad1d9a88a040663a734",
    "name": "Abdulazeez",
    "product": "TestDriven TDD Course",
    "rating": 4.9,
    "review": "Excellent course!",
    "date": "2022-05-17T13:53:17.196000"
  }
]

Ensuite, testons la route pour récupérer un seul enregistrement correspondant à un ID fourni :

$ curl -X 'GET' \
  'http://0.0.0.0:8000/reviews/62839ad1d9a88a040663a734' \
  -H 'accept: application/json'

Réponse:

{
  "_id": "62839ad1d9a88a040663a734",
  "name": "Abdulazeez",
  "product": "TestDriven TDD Course",
  "rating": 4.9,
  "review": "Excellent course!",
  "date": "2022-05-17T13:53:17.196000"
}

Mise à jour

Ensuite, écrivons la route pour mettre à jour l'enregistrement de révision :

@router.put("/{id}", response_description="Review record updated")
async def update_student_data(id: PydanticObjectId, req: UpdateProductReview) -> ProductReview:
    req = {k: v for k, v in req.dict().items() if v is not None}
    update_query = {"$set": {
        field: value for field, value in req.items()
    }}

    review = await ProductReview.get(id)
    if not review:
        raise HTTPException(
            status_code=404,
            detail="Review record not found!"
        )

    await review.update(update_query)
    return review

Dans cette fonction, nous avons filtré les champs qui ne sont pas mis à jour pour éviter d'écraser les champs existants avec None.

Pour mettre à jour un enregistrement, une requête de mise à jour est requise. Nous avons défini une requête de mise à jour qui écrase les champs existants avec les données transmises dans le corps de la requête. Nous avons ensuite vérifié si l'enregistrement existe. S'il existe, il est mis à jour et l'enregistrement mis à jour est renvoyé, sinon une exception 404 est déclenchée.

Testons le parcours :

$ curl -X 'PUT' \
  'http://0.0.0.0:8000/reviews/62839ad1d9a88a040663a734' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Abdulazeez Abdulazeez",
  "product": "TestDriven TDD Course",
  "rating": 5
}'

Réponse:

{
  "_id": "62839ad1d9a88a040663a734",
  "name": "Abdulazeez Abdulazeez",
  "product": "TestDriven TDD Course",
  "rating": 5.0,
  "review": "Excellent course!",
  "date": "2022-05-17T13:53:17.196000"
}

Effacer

Enfin, écrivons la route responsable de la suppression d'un enregistrement :

@router.delete("/{id}", response_description="Review record deleted from the database")
async def delete_student_data(id: PydanticObjectId) -> dict:
    record = await ProductReview.get(id)

    if not record:
        raise HTTPException(
            status_code=404,
            detail="Review record not found!"
        )

    await record.delete()
    return {
        "message": "Record deleted successfully"
    }

Donc, nous avons d'abord vérifié si l'enregistrement existe avant de procéder à sa suppression. L'enregistrement est supprimé en appelant la méthode delete() .

Testons le parcours :

$ curl -X 'DELETE' \
  'http://0.0.0.0:8000/reviews/62839ad1d9a88a040663a734' \
  -H 'accept: application/json'

Réponse:

{
  "message": "Record deleted successfully"
}

Nous avons construit avec succès une application CRUD optimisée par FastAPI, MongoDB et Beanie ODM.

Conclusion

Dans ce didacticiel, vous avez appris à créer une application CRUD avec FastAPI, MongoDB et Beanie ODM. Effectuez une auto-vérification rapide en passant en revue les objectifs au début du didacticiel, vous pouvez trouver le code utilisé dans ce didacticiel sur GitHub .

Source:  https://testdrive.io

#crud #fastapi #mongodb #api 

What is GEEK

Buddha Community

Comment Développer Une API Asynchrone Avec FastAPI Et MongoDB

Dans ce tutoriel, vous apprendrez à développer une API asynchrone avec FastAPI et MongoDB . Nous utiliserons la bibliothèque Beanie ODM pour interagir avec MongoDB de manière asynchrone.

Objectifs

À la fin de ce didacticiel, vous serez en mesure de :

1. Expliquez ce qu'est Beanie ODM et pourquoi vous voudrez peut-être l'utiliser
2. Interagissez avec MongoDB de manière asynchrone à l'aide de Beanie ODM
3. Développer une API RESTful avec Python et FastAPI

Pourquoi Beanie ODM ?

Beanie est un mappeur objet-document (ODM) asynchrone pour MongoDB, qui prend en charge les migrations de données et de schémas prêtes à l'emploi. Il utilise Motor , comme moteur de base de données asynchrone, et Pydantic .

Bien que vous puissiez simplement utiliser Motor, Beanie fournit une couche d'abstraction supplémentaire, ce qui facilite grandement l'interaction avec les collections dans une base de données Mongo.

Vous voulez simplement utiliser Motor ? Découvrez Créer une application CRUD avec FastAPI et MongoDB .

La configuration initiale

Commencez par créer un nouveau dossier pour contenir votre projet appelé "fastapi-beanie":

$ mkdir fastapi-beanie
$ cd fastapi-beanie

Ensuite, créez et activez un environnement virtuel :

$ python3.10 -m venv venv
$ source venv/bin/activate
(venv)$ export PYTHONPATH=$PWD

N'hésitez pas à échanger venv et Pip contre Poetry ou Pipenv . Pour en savoir plus, consultez Environnements Python modernes .

Ensuite, créez les fichiers et dossiers suivants :

├── app
│   ├── __init__.py
│   ├── main.py
│   └── server
│       ├── app.py
│       ├── database.py
│       ├── models
│       └── routes
└── requirements.txt

Ajoutez les dépendances suivantes à votre fichier requirements.txt :

beanie==1.11.0
fastapi==0.78.0
uvicorn==0.17.6

Installez les dépendances depuis votre terminal :

(venv)$ pip install -r requirements.txt

Dans le fichier app/main.py , définissez un point d'entrée pour exécuter l'application :

import uvicorn

if __name__ == "__main__":
    uvicorn.run("server.app:app", host="0.0.0.0", port=8000, reload=True)

Ici, nous avons demandé au fichier d'exécuter un serveur Uvicorn sur le port 8000 et de le recharger à chaque modification de fichier.

Avant de démarrer le serveur via le fichier de point d'entrée, créez une route de base dans app/server/app.py :

from fastapi import FastAPI

app = FastAPI()


@app.get("/", tags=["Root"])
async def read_root() -> dict:
    return {"message": "Welcome to your beanie powered app!"}

Exécutez le fichier de point d'entrée depuis votre console :

(venv)$ python app/main.py

Accédez à http://localhost:8000 dans votre navigateur. Tu devrais voir:

{
  "message": "Welcome to your beanie powered app!"
}

Que construisons-nous ?

Nous allons créer une application d'évaluation de produits qui nous permettra d'effectuer les opérations suivantes :

• Créer des avis
• Lire les avis
• Mettre à jour les avis
• Supprimer les avis

Avant de plonger dans l'écriture des routes, utilisons Beanie pour configurer le modèle de base de données pour notre application.

Schéma de base de données

Beanie vous permet de créer des documents qui peuvent ensuite être utilisés pour interagir avec les collections de la base de données. Les documents représentent le schéma de votre base de données. Ils peuvent être définis en créant des classes enfants qui héritent de la Documentclasse de Beanie. La Documentclasse est alimentée par Pydantic's BaseModel, ce qui facilite la définition des collections et du schéma de base de données ainsi que des exemples de données affichés dans la page de documentation interactive de Swagger.

Exemple:

from beanie import Document


class TestDrivenArticle(Document):
    title: str
    content: str
    date: datetime
    author: str

Le document défini représente la façon dont les articles seront stockés dans la base de données. Cependant, il s'agit d'une classe de document normale sans collection de base de données associée. Pour associer une collection, il vous suffit d'ajouter une Settingsclasse en tant que sous-classe :

from beanie import Document


class TestDrivenArticle(Document):
    title: str
    content: str
    date: datetime
    author: str


    class Settings:
        name = "testdriven_collection"

Maintenant que nous avons une idée de la façon dont les schémas sont créés, nous allons créer le schéma de notre application. Dans le dossier "app/server/models", créez un nouveau fichier appelé product_review.py :

from datetime import datetime

from beanie import Document
from pydantic import BaseModel
from typing import Optional


class ProductReview(Document):
    name: str
    product: str
    rating: float
    review: str
    date: datetime = datetime.now()

    class Settings:
        name = "product_review"

Étant donné que la Documentclasse est alimentée par Pydantic, nous pouvons définir des exemples de données de schéma pour faciliter l'utilisation de l'API par les développeurs à partir des documents interactifs Swagger.

Ajoutez la sous- Configclasse comme suit :

from datetime import datetime

from beanie import Document
from pydantic import BaseModel
from typing import Optional


class ProductReview(Document):
    name: str
    product: str
    rating: float
    review: str
    date: datetime = datetime.now()

    class Settings:
        name = "product_review"

    class Config:
        schema_extra = {
            "example": {
                "name": "Abdulazeez",
                "product": "TestDriven TDD Course",
                "rating": 4.9,
                "review": "Excellent course!",
                "date": datetime.now()
            }
        }

Ainsi, dans le bloc de code ci-dessus, nous avons défini un document Beanie appelé ProductReviewqui représente la façon dont une revue de produit sera stockée. Nous avons également défini la collection, product_review, où les données seront stockées.

Nous utiliserons ce schéma dans la route pour appliquer le corps de requête approprié.

Définissons enfin le schéma de mise à jour d'un avis produit :

class UpdateProductReview(BaseModel):
    name: Optional[str]
    product: Optional[str]
    rating: Optional[float]
    review: Optional[str]
    date: Optional[datetime]

    class Config:
        schema_extra = {
            "example": {
                "name": "Abdulazeez Abdulazeez",
                "product": "TestDriven TDD Course",
                "rating": 5.0,
                "review": "Excellent course!",
                "date": datetime.now()
            }
        }

La UpdateProductReviewclasse ci-dessus est de type BaseModel , ce qui nous permet de modifier uniquement les champs présents dans le corps de la requête.

Avec le schéma en place, configurons MongoDB et notre base de données avant de procéder à l'écriture des routes.

MongoDB

Dans cette section, nous allons connecter MongoDB et configurer notre application pour communiquer avec elle.

Selon Wikipedia , MongoDB est un programme de base de données multiplateforme orienté document. Classé comme programme de base de données NoSQL, MongoDB utilise des documents de type JSON avec des schémas facultatifs.

Configuration de MongoDB

Si MongoDB n'est pas installé sur votre machine, reportez-vous au guide d' installation de la documentation. Une fois installé, continuez avec le guide pour exécuter le processus du démon mongod . Une fois cela fait, vous pouvez vérifier que MongoDB est opérationnel en vous connectant à l'instance via la mongocommande shell :

$ mongo

Pour référence, ce tutoriel utilise MongoDB Community Edition v5.0.7.

$ mongo --version
MongoDB shell version v5.0.7

Build Info: {
    "version": "5.0.7",
    "gitVersion": "b977129dc70eed766cbee7e412d901ee213acbda",
    "modules": [],
    "allocator": "system",
    "environment": {
        "distarch": "x86_64",
        "target_arch": "x86_64"
    }
}

Configuration de la base de données

Dans database.py , ajoutez ce qui suit :

from beanie import init_beanie
import motor.motor_asyncio

from app.server.models.product_review import ProductReview


async def init_db():
    client = motor.motor_asyncio.AsyncIOMotorClient(
        "mongodb://localhost:27017/productreviews"
    )

    await init_beanie(database=client.db_name, document_models=[ProductReview])

Dans le bloc de code ci-dessus, nous avons importé la méthode init_beanie qui est responsable de l'initialisation du moteur de base de données alimenté par motor.motor_asyncio . La init_beanieméthode prend deux arguments :

1. database- Le nom de la base de données à utiliser.
2. document_models- Une liste de modèles de documents définis -- le ProductReviewmodèle, dans notre cas.

La init_dbfonction sera invoquée dans l'événement de démarrage de l'application. Mettez à jour app.py pour inclure l'événement de démarrage :

from fastapi import FastAPI

from app.server.database import init_db


app = FastAPI()


@app.on_event("startup")
async def start_db():
    await init_db()


@app.get("/", tags=["Root"])
async def read_root() -> dict:
    return {"message": "Welcome to your beanie powered app!"}

Maintenant que nos configurations de base de données sont en place, écrivons les routes.

Itinéraires

Dans cette section, nous allons construire les routes pour effectuer des opérations CRUD sur votre base de données depuis l'application :

1. Examen APRÈS-VENTE
2. OBTENEZ un avis unique et OBTENEZ tous les avis
3. PUT examen unique
4. SUPPRIMER un seul avis

Dans le dossier "routes", créez un fichier nommé product_review.py :

from beanie import PydanticObjectId
from fastapi import APIRouter, HTTPException
from typing import List

from app.server.models.product_review import ProductReview, UpdateProductReview


router = APIRouter()

Dans le bloc de code ci-dessus, nous avons importé PydanticObjectId, qui sera utilisé pour indiquer le type de l'argument ID lors de la récupération d'une seule requête. Nous avons également importé la APIRouterclasse responsable de la gestion des opérations de routage. Nous avons également importé la classe de modèle que nous avons définie précédemment.

Les modèles de document Beanie nous permettent d'interagir directement avec la base de données avec moins de code. Par exemple, pour récupérer tous les enregistrements d'une collection de base de données, il suffit de :

data = await ProductReview.find_all().to_list()
return data # A list of all records in the collection.

Avant de procéder à l'écriture de la fonction route pour les opérations CRUD, enregistrons la route dans app.py :

from fastapi import FastAPI

from app.server.database import init_db
from app.server.routes.product_review import router as Router


app = FastAPI()
app.include_router(Router, tags=["Product Reviews"], prefix="/reviews")


@app.on_event("startup")
async def start_db():
    await init_db()


@app.get("/", tags=["Root"])
async def read_root() -> dict:
    return {"message": "Welcome to your beanie powered app!"}

Créer

Dans routes/product_review.py , ajoutez ce qui suit :

@router.post("/", response_description="Review added to the database")
async def add_product_review(review: ProductReview) -> dict:
    await review.create()
    return {"message": "Review added successfully"}

Ici, nous avons défini la fonction route, qui prend un argument de type ProductReview. Comme indiqué précédemment, la classe de document peut interagir directement avec la base de données.

Le nouvel enregistrement est créé en appelant la méthode create() .

La route ci-dessus attend une charge utile similaire à celle-ci :

{
  "name": "Abdulazeez",
  "product": "TestDriven TDD Course",
  "rating": 4.9,
  "review": "Excellent course!",
  "date": "2022-05-17T13:53:17.196135"
}

Testez le parcours :

$ curl -X 'POST' \
  'http://0.0.0.0:8000/reviews/' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Abdulazeez",
  "product": "TestDriven TDD Course",
  "rating": 4.9,
  "review": "Excellent course!",
  "date": "2022-05-17T13:53:17.196135"
}'

La requête ci-dessus doit renvoyer un message de réussite :

{
  "message": "Review added successfully"
}

Lis

Viennent ensuite les routes qui nous permettent de récupérer un seul avis et tous les avis présents dans la base de données :

@router.get("/{id}", response_description="Review record retrieved")
async def get_review_record(id: PydanticObjectId) -> ProductReview:
    review = await ProductReview.get(id)
    return review


@router.get("/", response_description="Review records retrieved")
async def get_reviews() -> List[ProductReview]:
    reviews = await ProductReview.find_all().to_list()
    return reviews

Dans le bloc de code ci-dessus, nous avons défini deux fonctions :

1. Dans la première fonction, la fonction prend un ID de type ObjectiD, l'encodage par défaut pour les ID MongoDB. L'enregistrement est récupéré à l'aide de la méthode get() .
2. Dans le second, nous avons récupéré tous les avis à l'aide de la méthode find_all() . La to_list()méthode est ajoutée afin que les résultats soient renvoyés dans une liste.

Une autre méthode qui peut être utilisée pour récupérer une seule entrée est la méthode find_one() qui prend une condition. Par exemple:

# Return a record who has a rating of 4.0
await ProductReview.find_one(ProductReview.rating == 4.0)

Testons la première route pour récupérer tous les enregistrements :

$ curl -X 'GET' \
  'http://0.0.0.0:8000/reviews/' \
  -H 'accept: application/json'

Réponse:

[
  {
    "_id": "62839ad1d9a88a040663a734",
    "name": "Abdulazeez",
    "product": "TestDriven TDD Course",
    "rating": 4.9,
    "review": "Excellent course!",
    "date": "2022-05-17T13:53:17.196000"
  }
]

Ensuite, testons la route pour récupérer un seul enregistrement correspondant à un ID fourni :

$ curl -X 'GET' \
  'http://0.0.0.0:8000/reviews/62839ad1d9a88a040663a734' \
  -H 'accept: application/json'

Réponse:

{
  "_id": "62839ad1d9a88a040663a734",
  "name": "Abdulazeez",
  "product": "TestDriven TDD Course",
  "rating": 4.9,
  "review": "Excellent course!",
  "date": "2022-05-17T13:53:17.196000"
}

Mise à jour

Ensuite, écrivons la route pour mettre à jour l'enregistrement de révision :

@router.put("/{id}", response_description="Review record updated")
async def update_student_data(id: PydanticObjectId, req: UpdateProductReview) -> ProductReview:
    req = {k: v for k, v in req.dict().items() if v is not None}
    update_query = {"$set": {
        field: value for field, value in req.items()
    }}

    review = await ProductReview.get(id)
    if not review:
        raise HTTPException(
            status_code=404,
            detail="Review record not found!"
        )

    await review.update(update_query)
    return review

Dans cette fonction, nous avons filtré les champs qui ne sont pas mis à jour pour éviter d'écraser les champs existants avec None.

Pour mettre à jour un enregistrement, une requête de mise à jour est requise. Nous avons défini une requête de mise à jour qui écrase les champs existants avec les données transmises dans le corps de la requête. Nous avons ensuite vérifié si l'enregistrement existe. S'il existe, il est mis à jour et l'enregistrement mis à jour est renvoyé, sinon une exception 404 est déclenchée.

Testons le parcours :

$ curl -X 'PUT' \
  'http://0.0.0.0:8000/reviews/62839ad1d9a88a040663a734' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Abdulazeez Abdulazeez",
  "product": "TestDriven TDD Course",
  "rating": 5
}'

Réponse:

{
  "_id": "62839ad1d9a88a040663a734",
  "name": "Abdulazeez Abdulazeez",
  "product": "TestDriven TDD Course",
  "rating": 5.0,
  "review": "Excellent course!",
  "date": "2022-05-17T13:53:17.196000"
}

Effacer

Enfin, écrivons la route responsable de la suppression d'un enregistrement :

@router.delete("/{id}", response_description="Review record deleted from the database")
async def delete_student_data(id: PydanticObjectId) -> dict:
    record = await ProductReview.get(id)

    if not record:
        raise HTTPException(
            status_code=404,
            detail="Review record not found!"
        )

    await record.delete()
    return {
        "message": "Record deleted successfully"
    }

Donc, nous avons d'abord vérifié si l'enregistrement existe avant de procéder à sa suppression. L'enregistrement est supprimé en appelant la méthode delete() .

Testons le parcours :

$ curl -X 'DELETE' \
  'http://0.0.0.0:8000/reviews/62839ad1d9a88a040663a734' \
  -H 'accept: application/json'

Réponse:

{
  "message": "Record deleted successfully"
}

Nous avons construit avec succès une application CRUD optimisée par FastAPI, MongoDB et Beanie ODM.

Conclusion

Dans ce didacticiel, vous avez appris à créer une application CRUD avec FastAPI, MongoDB et Beanie ODM. Effectuez une auto-vérification rapide en passant en revue les objectifs au début du didacticiel, vous pouvez trouver le code utilisé dans ce didacticiel sur GitHub .

Source:  https://testdrive.io

#crud #fastapi #mongodb #api 

Top 10 API Security Threats Every API Team Should Know

As more and more data is exposed via APIs either as API-first companies or for the explosion of single page apps/JAMStack, API security can no longer be an afterthought. The hard part about APIs is that it provides direct access to large amounts of data while bypassing browser precautions. Instead of worrying about SQL injection and XSS issues, you should be concerned about the bad actor who was able to paginate through all your customer records and their data.

Typical prevention mechanisms like Captchas and browser fingerprinting won’t work since APIs by design need to handle a very large number of API accesses even by a single customer. So where do you start? The first thing is to put yourself in the shoes of a hacker and then instrument your APIs to detect and block common attacks along with unknown unknowns for zero-day exploits. Some of these are on the OWASP Security API list, but not all.

Insecure pagination and resource limits

Most APIs provide access to resources that are lists of entities such as /users or /widgets. A client such as a browser would typically filter and paginate through this list to limit the number items returned to a client like so:

First Call: GET /items?skip=0&take=10 
Second Call: GET /items?skip=10&take=10

However, if that entity has any PII or other information, then a hacker could scrape that endpoint to get a dump of all entities in your database. This could be most dangerous if those entities accidently exposed PII or other sensitive information, but could also be dangerous in providing competitors or others with adoption and usage stats for your business or provide scammers with a way to get large email lists. See how Venmo data was scraped

A naive protection mechanism would be to check the take count and throw an error if greater than 100 or 1000. The problem with this is two-fold:

1. For data APIs, legitimate customers may need to fetch and sync a large number of records such as via cron jobs. Artificially small pagination limits can force your API to be very chatty decreasing overall throughput. Max limits are to ensure memory and scalability requirements are met (and prevent certain DDoS attacks), not to guarantee security.
2. This offers zero protection to a hacker that writes a simple script that sleeps a random delay between repeated accesses.

skip = 0
while True:    response = requests.post('https://api.acmeinc.com/widgets?take=10&skip=' + skip),                      headers={'Authorization': 'Bearer' + ' ' + sys.argv[1]})    print("Fetched 10 items")    sleep(randint(100,1000))    skip += 10

How to secure against pagination attacks

To secure against pagination attacks, you should track how many items of a single resource are accessed within a certain time period for each user or API key rather than just at the request level. By tracking API resource access at the user level, you can block a user or API key once they hit a threshold such as “touched 1,000,000 items in a one hour period”. This is dependent on your API use case and can even be dependent on their subscription with you. Like a Captcha, this can slow down the speed that a hacker can exploit your API, like a Captcha if they have to create a new user account manually to create a new API key.

Insecure API key generation

Most APIs are protected by some sort of API key or JWT (JSON Web Token). This provides a natural way to track and protect your API as API security tools can detect abnormal API behavior and block access to an API key automatically. However, hackers will want to outsmart these mechanisms by generating and using a large pool of API keys from a large number of users just like a web hacker would use a large pool of IP addresses to circumvent DDoS protection.

How to secure against API key pools

The easiest way to secure against these types of attacks is by requiring a human to sign up for your service and generate API keys. Bot traffic can be prevented with things like Captcha and 2-Factor Authentication. Unless there is a legitimate business case, new users who sign up for your service should not have the ability to generate API keys programmatically. Instead, only trusted customers should have the ability to generate API keys programmatically. Go one step further and ensure any anomaly detection for abnormal behavior is done at the user and account level, not just for each API key.

Accidental key exposure

APIs are used in a way that increases the probability credentials are leaked:

1. APIs are expected to be accessed over indefinite time periods, which increases the probability that a hacker obtains a valid API key that’s not expired. You save that API key in a server environment variable and forget about it. This is a drastic contrast to a user logging into an interactive website where the session expires after a short duration.
2. The consumer of an API has direct access to the credentials such as when debugging via Postman or CURL. It only takes a single developer to accidently copy/pastes the CURL command containing the API key into a public forum like in GitHub Issues or Stack Overflow.
3. API keys are usually bearer tokens without requiring any other identifying information. APIs cannot leverage things like one-time use tokens or 2-factor authentication.

If a key is exposed due to user error, one may think you as the API provider has any blame. However, security is all about reducing surface area and risk. Treat your customer data as if it’s your own and help them by adding guards that prevent accidental key exposure.

How to prevent accidental key exposure

The easiest way to prevent key exposure is by leveraging two tokens rather than one. A refresh token is stored as an environment variable and can only be used to generate short lived access tokens. Unlike the refresh token, these short lived tokens can access the resources, but are time limited such as in hours or days.

The customer will store the refresh token with other API keys. Then your SDK will generate access tokens on SDK init or when the last access token expires. If a CURL command gets pasted into a GitHub issue, then a hacker would need to use it within hours reducing the attack vector (unless it was the actual refresh token which is low probability)

Exposure to DDoS attacks

APIs open up entirely new business models where customers can access your API platform programmatically. However, this can make DDoS protection tricky. Most DDoS protection is designed to absorb and reject a large number of requests from bad actors during DDoS attacks but still need to let the good ones through. This requires fingerprinting the HTTP requests to check against what looks like bot traffic. This is much harder for API products as all traffic looks like bot traffic and is not coming from a browser where things like cookies are present.

Stopping DDoS attacks

The magical part about APIs is almost every access requires an API Key. If a request doesn’t have an API key, you can automatically reject it which is lightweight on your servers (Ensure authentication is short circuited very early before later middleware like request JSON parsing). So then how do you handle authenticated requests? The easiest is to leverage rate limit counters for each API key such as to handle X requests per minute and reject those above the threshold with a 429 HTTP response. There are a variety of algorithms to do this such as leaky bucket and fixed window counters.

Incorrect server security

APIs are no different than web servers when it comes to good server hygiene. Data can be leaked due to misconfigured SSL certificate or allowing non-HTTPS traffic. For modern applications, there is very little reason to accept non-HTTPS requests, but a customer could mistakenly issue a non HTTP request from their application or CURL exposing the API key. APIs do not have the protection of a browser so things like HSTS or redirect to HTTPS offer no protection.

How to ensure proper SSL

Test your SSL implementation over at Qualys SSL Test or similar tool. You should also block all non-HTTP requests which can be done within your load balancer. You should also remove any HTTP headers scrub any error messages that leak implementation details. If your API is used only by your own apps or can only be accessed server-side, then review Authoritative guide to Cross-Origin Resource Sharing for REST APIs

Incorrect caching headers

APIs provide access to dynamic data that’s scoped to each API key. Any caching implementation should have the ability to scope to an API key to prevent cross-pollution. Even if you don’t cache anything in your infrastructure, you could expose your customers to security holes. If a customer with a proxy server was using multiple API keys such as one for development and one for production, then they could see cross-pollinated data.

#api management #api security #api best practices #api providers #security analytics #api management policies #api access tokens #api access #api security risks #api access keys

Comment Développer Une API Asynchrone Avec FastAPI Et MongoDB

Dans ce tutoriel, vous apprendrez à développer une API asynchrone avec FastAPI et MongoDB . Nous utiliserons le package Motor pour interagir avec MongoDB de manière asynchrone.

Objectifs

À la fin de ce didacticiel, vous serez en mesure de :

1. Développer une API RESTful avec Python et FastAPI
2. Interagissez avec MongoDB de manière asynchrone
3. Exécutez MongoDB dans le cloud avec MongoDB Atlas
4. Déployer une application FastAPI sur Heroku

La configuration initiale

Commencez par créer un nouveau dossier pour contenir votre projet appelé "fastapi-mongo":

$ mkdir fastapi-mongo
$ cd fastapi-mongo

Ensuite, créez et activez un environnement virtuel :

$ python3.9 -m venv venv
$ source venv/bin/activate
$ export PYTHONPATH=$PWD

N'hésitez pas à échanger virtualenv et Pip contre Poetry ou Pipenv . Pour en savoir plus, consultez Environnements Python modernes .

Ensuite, créez les fichiers et dossiers suivants :

├── app
│   ├── __init__.py
│   ├── main.py
│   └── server
│       ├── app.py
│       ├── database.py
│       ├── models
│       └── routes
└── requirements.txt

Ajoutez les dépendances suivantes à votre fichier requirements.txt :

fastapi==0.73.0
uvicorn==0.17.4

Installez-les :

(venv)$ pip install -r requirements.txt

Dans le fichier app/main.py , définissez un point d'entrée pour exécuter l'application :

import uvicorn

if __name__ == "__main__":
    uvicorn.run("server.app:app", host="0.0.0.0", port=8000, reload=True)

Ici, nous avons demandé au fichier d'exécuter un serveur Uvicorn sur le port 8000 et de le recharger à chaque modification de fichier.

Avant de démarrer le serveur via le fichier de point d'entrée, créez une route de base dans app/server/app.py :

from fastapi import FastAPI

app = FastAPI()


@app.get("/", tags=["Root"])
async def read_root():
    return {"message": "Welcome to this fantastic app!"}

Les balises sont des identifiants utilisés pour regrouper les routes. Les routes avec les mêmes balises sont regroupées dans une section de la documentation de l'API.

Exécutez le fichier de point d'entrée depuis votre console :

(venv)$ python app/main.py

Accédez à http://localhost:8000 dans votre navigateur. Tu devrais voir:

{
  "message": "Welcome to this fantastic app!"
}

Vous pouvez également consulter la documentation interactive de l'API sur http://localhost:8000/docs :

Itinéraires

Nous allons créer une application simple pour stocker les données des étudiants avec les itinéraires CRUD suivants :

Avant de plonger dans l'écriture des routes, définissons d'abord le schéma pertinent et configurons MongoDB.

Schéma

Définissons le schéma sur lequel nos données seront basées, qui représentera la façon dont les données sont stockées dans la base de données MongoDB.

Les schémas Pydantic sont utilisés pour valider les données avec la sérialisation (JSON -> Python) et la désérialisation (Python -> JSON). En d'autres termes, il ne sert pas de validateur de schéma Mongo.

Dans le dossier "app/server/models", créez un nouveau fichier appelé student.py :

from typing import Optional

from pydantic import BaseModel, EmailStr, Field


class StudentSchema(BaseModel):
    fullname: str = Field(...)
    email: EmailStr = Field(...)
    course_of_study: str = Field(...)
    year: int = Field(..., gt=0, lt=9)
    gpa: float = Field(..., le=4.0)

    class Config:
        schema_extra = {
            "example": {
                "fullname": "John Doe",
                "email": "jdoe@x.edu.ng",
                "course_of_study": "Water resources engineering",
                "year": 2,
                "gpa": "3.0",
            }
        }


class UpdateStudentModel(BaseModel):
    fullname: Optional[str]
    email: Optional[EmailStr]
    course_of_study: Optional[str]
    year: Optional[int]
    gpa: Optional[float]

    class Config:
        schema_extra = {
            "example": {
                "fullname": "John Doe",
                "email": "jdoe@x.edu.ng",
                "course_of_study": "Water resources and environmental engineering",
                "year": 4,
                "gpa": "4.0",
            }
        }


def ResponseModel(data, message):
    return {
        "data": [data],
        "code": 200,
        "message": message,
    }


def ErrorResponseModel(error, code, message):
    return {"error": error, "code": code, "message": message}

Dans le code ci-dessus, nous avons défini un schéma Pydantic appelé StudentSchemaqui représente la manière dont les données des étudiants seront stockées dans votre base de données MongoDB.

Dans Pydantic, les points de suspension , ..., indiquent qu'un champ est requis. Il peut être remplacé par Noneou par une valeur par défaut. Dans StudentSchema, chaque champ comporte des points de suspension, car chaque champ est important et le programme ne doit pas continuer sans que les valeurs soient définies.

Dans le champ gpaet du , nous avons ajouté les validateurs , et :yearStudentSchema gtltle

1. gtet ltdans le yearchamp assure que la valeur passée est supérieure à 0 et inférieure à 9 . Par conséquent, des valeurs telles que 0 , 10 , 11 , entraîneront des erreurs.
2. levalidator dans le gpachamp garantit que la valeur transmise est inférieure ou égale à 4.0 .

Ce schéma aidera les utilisateurs à envoyer des requêtes HTTP avec la forme appropriée à l'API, c'est-à-dire le type de données à envoyer et comment les envoyer.

FastAPI utilise Pyantic Schemas pour documenter automatiquement les modèles de données en conjonction avec Json Schema . Swagger UI restitue ensuite les données à partir des modèles de données générés. Vous pouvez en savoir plus sur la façon dont FastAPI génère la documentation de l'API ici .

Depuis que nous avons utilisé EmailStr, nous devons installer email-validator .

Ajoutez-le au fichier requirements :

pydantic[email]

Installer:

(venv)$ pip install -r requirements.txt

Avec le schéma en place, configurons MongoDB avant d'écrire les routes pour l'API.

MongoDB

Dans cette section, nous allons câbler MongoDB et configurer notre application pour communiquer avec elle.

Selon Wikipedia , MongoDB est un programme de base de données multiplateforme orienté document. Classé comme programme de base de données NoSQL, MongoDB utilise des documents de type JSON avec des schémas facultatifs.

Configuration de MongoDB

Si MongoDB n'est pas installé sur votre machine, reportez-vous au guide d' installation de la documentation. Une fois installé, continuez avec le guide pour exécuter le processus du démon mongod . Une fois cela fait, vous pouvez vérifier que MongoDB est opérationnel en vous connectant à l'instance via la mongocommande shell :

$ mongo

Pour référence, ce tutoriel utilise MongoDB Community Edition v5.0.6.

$ mongo --version

MongoDB shell version v5.0.6

Build Info: {
    "version": "5.0.6",
    "gitVersion": "212a8dbb47f07427dae194a9c75baec1d81d9259",
    "modules": [],
    "allocator": "system",
    "environment": {
        "distarch": "x86_64",
        "target_arch": "x86_64"
    }
}

Configuration du moteur

Ensuite, nous allons configurer Motor , un pilote MongoDB asynchrone, pour interagir avec la base de données.

Commencez par ajouter la dépendance au fichier requirements :

motor==2.5.1

Installer:

(venv)$ pip install -r requirements.txt

De retour dans l'application, ajoutez les informations de connexion à la base de données à app/server/database.py :

import motor.motor_asyncio

MONGO_DETAILS = "mongodb://localhost:27017"

client = motor.motor_asyncio.AsyncIOMotorClient(MONGO_DETAILS)

database = client.students

student_collection = database.get_collection("students_collection")

Dans le code ci-dessus, nous avons importé Motor, défini les détails de connexion et créé un client via AsyncIOMotorClient .

Nous avons ensuite référencé une base de données appelée studentset une collection (semblable à une table dans une base de données relationnelle) appelée students_collection. Puisqu'il ne s'agit que de références et non d'E/S réelles, aucune ne nécessite d' awaitexpression. Lorsque la première opération d'E/S est effectuée, la base de données et la collection seront créées si elles n'existent pas déjà.

Ensuite, créez une fonction d'assistance rapide pour analyser les résultats d'une requête de base de données dans un dict Python.

Ajoutez ceci également au fichier database.py :

import motor.motor_asyncio

MONGO_DETAILS = "mongodb://localhost:27017"

client = motor.motor_asyncio.AsyncIOMotorClient(MONGO_DETAILS)

database = client.students

student_collection = database.get_collection("students_collection")


# helpers


def student_helper(student) -> dict:
    return {
        "id": str(student["_id"]),
        "fullname": student["fullname"],
        "email": student["email"],
        "course_of_study": student["course_of_study"],
        "year": student["year"],
        "GPA": student["gpa"],
    }

Ensuite, écrivons les opérations de la base de données CRUD.

Opérations CRUD de la base de données

Commencez par importer la ObjectIdméthode du package bson en haut du fichier database.py :

from bson.objectid import ObjectId

bson est installé en tant que dépendance du moteur.

Ensuite, ajoutez chacune des fonctions suivantes pour les opérations CRUD :

# Retrieve all students present in the database
async def retrieve_students():
    students = []
    async for student in student_collection.find():
        students.append(student_helper(student))
    return students


# Add a new student into to the database
async def add_student(student_data: dict) -> dict:
    student = await student_collection.insert_one(student_data)
    new_student = await student_collection.find_one({"_id": student.inserted_id})
    return student_helper(new_student)


# Retrieve a student with a matching ID
async def retrieve_student(id: str) -> dict:
    student = await student_collection.find_one({"_id": ObjectId(id)})
    if student:
        return student_helper(student)


# Update a student with a matching ID
async def update_student(id: str, data: dict):
    # Return false if an empty request body is sent.
    if len(data) < 1:
        return False
    student = await student_collection.find_one({"_id": ObjectId(id)})
    if student:
        updated_student = await student_collection.update_one(
            {"_id": ObjectId(id)}, {"$set": data}
        )
        if updated_student:
            return True
        return False


# Delete a student from the database
async def delete_student(id: str):
    student = await student_collection.find_one({"_id": ObjectId(id)})
    if student:
        await student_collection.delete_one({"_id": ObjectId(id)})
        return True

Dans le code ci-dessus, nous avons défini les opérations asynchrones pour créer, lire, mettre à jour et supprimer les données des étudiants dans la base de données via motor.

Dans les opérations de mise à jour et de suppression, l'étudiant est recherché dans la base de données pour décider d'effectuer ou non l'opération. Les valeurs de retour guident la façon d'envoyer des réponses à l'utilisateur sur lesquelles nous travaillerons dans la section suivante.

Itinéraires CRUD

Dans cette section, nous ajouterons les routes pour compléter les opérations de base de données dans le fichier de base de données.

Dans le dossier "routes", créez un nouveau fichier appelé student.py et ajoutez-y le contenu suivant :

from fastapi import APIRouter, Body
from fastapi.encoders import jsonable_encoder

from app.server.database import (
    add_student,
    delete_student,
    retrieve_student,
    retrieve_students,
    update_student,
)
from app.server.models.student import (
    ErrorResponseModel,
    ResponseModel,
    StudentSchema,
    UpdateStudentModel,
)

router = APIRouter()

Nous utiliserons l' encodeur compatible JSON de FastAPI pour convertir nos modèles dans un format compatible JSON.

Ensuite, câblez la route de l'étudiant dans app/server/app.py :

from fastapi import FastAPI

from app.server.routes.student import router as StudentRouter

app = FastAPI()

app.include_router(StudentRouter, tags=["Student"], prefix="/student")


@app.get("/", tags=["Root"])
async def read_root():
    return {"message": "Welcome to this fantastic app!"}

Créer

De retour dans le fichier routes, ajoutez le gestionnaire suivant pour créer un nouvel étudiant :

@router.post("/", response_description="Student data added into the database")
async def add_student_data(student: StudentSchema = Body(...)):
    student = jsonable_encoder(student)
    new_student = await add_student(student)
    return ResponseModel(new_student, "Student added successfully.")

Ainsi, la route attend une charge utile qui correspond au format StudentSchema. Exemple:

{
    "fullname": "John Doe",
    "email": "jdoe@x.edu.ng",
    "course_of_study": "Water resources engineering",
    "year": 2,
    "gpa": "3.0",
}

Lancez le serveur Uvicorn :

(venv)$ python app/main.py

Et actualisez la page de documentation de l'API interactive à l' adresse http://localhost:8000/docs pour afficher la nouvelle route :

Testez-le également :

Ainsi, lorsqu'une demande est envoyée au point de terminaison, il stocke un corps de demande codé JSON dans la variable studentavant d'appeler la add_studentméthode de base de données et de stocker la réponse dans la new_studentvariable. La réponse de la base de données est ensuite renvoyée via le fichier ResponseModel.

Testez également les validateurs :

1. L'année doit être supérieure à 0 et inférieure à 10
2. GPA doit être inférieur ou égal à 4.0

Lis

En continuant, ajoutez les itinéraires suivants pour récupérer tous les étudiants et un seul étudiant :

@router.get("/", response_description="Students retrieved")
async def get_students():
    students = await retrieve_students()
    if students:
        return ResponseModel(students, "Students data retrieved successfully")
    return ResponseModel(students, "Empty list returned")


@router.get("/{id}", response_description="Student data retrieved")
async def get_student_data(id):
    student = await retrieve_student(id)
    if student:
        return ResponseModel(student, "Student data retrieved successfully")
    return ErrorResponseModel("An error occurred.", 404, "Student doesn't exist.")

Que se passe-t-il si vous ne transmettez pas un ObjectId valide -- par exemple, 1-- pour l'ID permettant de récupérer le parcours d'un seul étudiant ? Comment pouvez-vous mieux gérer cela dans l'application ?

Lorsque l'opération de suppression est implémentée, vous aurez la possibilité de tester la réponse pour une base de données vide.

Mise à jour

Ensuite, écrivez l'itinéraire individuel pour mettre à jour les données des étudiants :

@router.put("/{id}")
async def update_student_data(id: str, req: UpdateStudentModel = Body(...)):
    req = {k: v for k, v in req.dict().items() if v is not None}
    updated_student = await update_student(id, req)
    if updated_student:
        return ResponseModel(
            "Student with ID: {} name update is successful".format(id),
            "Student name updated successfully",
        )
    return ErrorResponseModel(
        "An error occurred",
        404,
        "There was an error updating the student data.",
    )

Effacer

Enfin, ajoutez la route de suppression :

@router.delete("/{id}", response_description="Student data deleted from the database")
async def delete_student_data(id: str):
    deleted_student = await delete_student(id)
    if deleted_student:
        return ResponseModel(
            "Student with ID: {} removed".format(id), "Student deleted successfully"
        )
    return ErrorResponseModel(
        "An error occurred", 404, "Student with id {0} doesn't exist".format(id)
    )

Récupérez l'ID de l'utilisateur que vous avez créé précédemment et testez la route de suppression :

Supprimez tous les étudiants restants et testez à nouveau les itinéraires de lecture, en vous assurant que les réponses sont appropriées pour une base de données vide.

Déploiement

Dans cette section, nous allons déployer l'application sur Heroku et configurer une base de données cloud pour MongoDB.

Atlas MongoDB

Avant le déploiement, nous devons configurer MongoDB Atlas , un service de base de données cloud pour MongoDB pour héberger notre base de données.

Suivez le guide de mise en route où vous allez créer un compte, déployer un cluster de niveau gratuit, configurer un utilisateur et ajouter une adresse IP à la liste blanche.

À des fins de test, utilisez 0.0.0.0/0l'adresse IP sur liste blanche pour autoriser l'accès depuis n'importe où. Pour une application de production, vous souhaiterez restreindre l'accès à une adresse IP statique.

Une fois cela fait, récupérez les informations de connexion à la base de données de votre cluster en cliquant sur le bouton "Se connecter":

Cliquez sur la deuxième option, "Se connecter à votre application":

Copiez l'URL de connexion en veillant à mettre à jour le mot de passe. Définissez également la base de données par défaut sur "étudiants". Il ressemblera à :

mongodb+srv://foobar:foobar@cluster0.0reol.mongodb.net/students?retryWrites=true&w=majority

Au lieu de coder en dur cette valeur dans notre application, nous définirons qu'elle a une variable d'environnement. Créez un nouveau fichier appelé .env à la racine du projet et les informations de connexion :

MONGO_DETAILS=your_connection_url

Assurez-vous de remplacer your_connection_urlpar l'URL copiée.

Ensuite, pour simplifier la gestion des variables d'environnement dans notre application, installons le package Python Decouple . Ajoutez-le à votre fichier d'exigences comme suit :

python-decouple==3.6

Installer:

(venv)$ pip install -r requirements.txt

Dans le fichier app/server/database.py , importez la bibliothèque :

from decouple import config

La méthode importée configparcourt le répertoire racine à la recherche d'un fichier .env et lit le contenu qui lui est transmis. Donc, dans notre cas, il lira la MONGO_DETAILSvariable.

Ensuite, changez la MONGO_DETAILSvariable en :

MONGO_DETAILS = config("MONGO_DETAILS")  # read environment variable

Tester localement

Avant de déployer, testons l'application localement avec la base de données cloud pour nous assurer que la connexion est correctement configurée. Redémarrez votre serveur Uvicorn et testez chaque route à partir de la documentation interactive sur http://localhost:8000/docs .

Vous devriez pouvoir voir les données sur le tableau de bord Atlas :

Déploiement sur Heroku

Enfin, déployons l'application sur Heroku .

Heroku est une plate-forme cloud en tant que service (PaaS) utilisée pour déployer et faire évoluer des applications.

Si nécessaire, créez un compte Heroku et installez la CLI Heroku .

Avant de continuer, créez un fichier .gitignore dans le projet pour empêcher l'archivage du dossier "venv" et du fichier .env dans git :

(venv)$ touch .gitignore

Ajoutez ce qui suit :

.env
venv/
__pycache__

Ensuite, ajoutez un Profile à la racine de votre projet :

web: uvicorn app.server.app:app --host 0.0.0.0 --port=$PORT

Remarques:

1. Un Procfile est un fichier texte, placé à la racine de votre projet, qui guide Heroku sur la façon d'exécuter votre application. Puisque nous servons une application Web, nous avons défini le type de processus webavec la commande pour servir Uvicorn.
2. Heroku expose dynamiquement un port pour que votre application s'exécute au moment du déploiement, qui est exposé via la $PORTvariable d'environnement.

Votre projet doit maintenant contenir les fichiers et dossiers suivants :

├── .env
├── .gitignore
├── Procfile
├── app
│   ├── __init__.py
│   ├── main.py
│   └── server
│       ├── app.py
│       ├── database.py
│       ├── models
│       │   └── student.py
│       └── routes
│           └── student.py
└── requirements.txt

Dans la racine de votre projet, initialisez un nouveau dépôt git :

(venv)$ git init
(venv)$ git add .
(venv)$ git commit -m "My fastapi and mongo application"

Maintenant, nous pouvons créer une nouvelle application sur Heroku :

(venv)$ heroku create

En plus de créer une nouvelle application, cette commande crée un référentiel git distant sur Heroku pour que nous poussions notre application pour le déploiement. Il définit ensuite cela comme une télécommande sur le référentiel local automatiquement pour nous.

Vous pouvez vérifier que la télécommande est définie en exécutant git remote -v.

Notez l'URL de votre application.

Comme nous n'avons pas ajouté le fichier .env à git, nous devons définir la variable d'environnement dans l'environnement Heroku :

(venv)$ heroku config:set MONGO_DETAILS="your_mongo_connection_url"

Encore une fois, assurez-vous de remplacer your_connection_urlpar la véritable URL de connexion.

Envoyez votre code à Heroku et assurez-vous qu'au moins une instance de l'application est en cours d'exécution :

(venv)$ git push heroku master
(venv)$ heroku ps:scale web=1

Exécutez heroku openpour ouvrir votre application dans votre navigateur par défaut.

Vous avez déployé avec succès votre application sur Heroku. Testez-le.

Conclusion

Dans ce didacticiel, vous avez appris à créer une application CRUD avec FastAPI et MongoDB et à la déployer sur Heroku. Effectuez une auto-vérification rapide en passant en revue les objectifs au début du didacticiel. Vous pouvez trouver le code utilisé dans ce tutoriel sur GitHub .

Source :  https://testdrive.io

#crud #fastapi #mongodb #heroku 

Public ASX100 APIs: The Essential List

We’ve conducted some initial research into the public APIs of the ASX100 because we regularly have conversations about what others are doing with their APIs and what best practices look like. Being able to point to good local examples and explain what is happening in Australia is a key part of this conversation.

Method

The method used for this initial research was to obtain a list of the ASX100 (as of 18 September 2020). Then work through each company looking at the following:

1. Whether the company had a public API: this was found by googling “[company name] API” and “[company name] API developer” and “[company name] developer portal”. Sometimes the company’s website was navigated or searched.
2. Some data points about the API were noted, such as the URL of the portal/documentation and the method they used to publish the API (portal, documentation, web page).
3. Observations were recorded that piqued the interest of the researchers (you will find these below).
4. Other notes were made to support future research.
5. You will find a summary of the data in the infographic below.

Data

With regards to how the APIs are shared:

• Documentation is where just the Swagger/OpenAPI docs are hosted somewhere. e.g. https://api.linkgroup.com/member/docs/index
• Portal is where an interactive portal has been developed. e.g. https://dev.telstra.com/
• The web page is where the company has a single page that isn’t interactive explaining their Public APIs. e.g. https://www.bendigoadelaide.com.au/banking-products-api.asp

#api #api-development #api-analytics #apis #api-integration #api-testing #api-security #api-gateway

An API-First Approach For Designing Restful APIs | Hacker Noon

I’ve been working with Restful APIs for some time now and one thing that I love to do is to talk about APIs.

So, today I will show you how to build an API using the API-First approach and Design First with OpenAPI Specification.

First thing first, if you don’t know what’s an API-First approach means, it would be nice you stop reading this and check the blog post that I wrote to the Farfetchs blog where I explain everything that you need to know to start an API using API-First.

Preparing the ground

Before you get your hands dirty, let’s prepare the ground and understand the use case that will be developed.

Tools

If you desire to reproduce the examples that will be shown here, you will need some of those items below.

• NodeJS
• OpenAPI Specification
• Text Editor (I’ll use VSCode)
• Command Line

Use Case

To keep easy to understand, let’s use the Todo List App, it is a very common concept beyond the software development community.

#api #rest-api #openai #api-first-development #api-design #apis #restful-apis #restful-api