meilisearch fastapi

Meilisearch FastAPI

Meilisearch FastAPI fournit des routes FastAPI pour interagir avec Meilisearch.

Installation

L'utilisation d'un environnement virtuel est recommandée pour installer ce package. Une fois l'environnement virtuel créé et activé, installez le package avec :

pip install meilisearch-fastapi

Utilisation

Les routes sont divisées en groupes afin que différentes dépendances puissent être injectées, et donc différents niveaux d'accès, peuvent être accordés à différents groupes de routes.

Exemple sans authentification requise pour les itinéraires

 from fastapi import APIRouter , FastAPI
from meilisearch_fastapi . routes import (
    document_routes ,
    index_routes ,
    meilisearch_routes ,
    search_routes ,
    settings_routes ,
)

app = FastAPI ()
api_router = APIRouter ()
api_router . include_router ( document_routes . router , prefix = "/documents" )
api_router . include_router ( index_routes . router , prefix = "/indexes" )
api_router . include_router ( meilisearch_routes . router , prefix = "/meilisearch" )
api_router . include_router ( search_routes . router , prefix = "/search" )
api_router . include_router ( settings_routes . router , prefix = "/settings" )

app . include_router ( api_router )

Exemple avec des routes nécessitant une authentification

 from fastapi import APIRouter , FastAPI
from meilisearch_fastapi . routes import (
    document_routes ,
    index_routes ,
    meilisearch_routes ,
    search_routes ,
    settings_routes ,
)

from my_app import my_authentication

app = FastAPI ()
api_router = APIRouter ()
api_router . include_router ( document_routes . router , prefix = "/documents" , dependeincies = [ Depends ( my_authentication )])
api_router . include_router ( index_routes . router , prefix = "/indexes" , dependeincies = [ Depends ( my_authentication )])
api_router . include_router ( meilisearch_routes . router , prefix = "/meilisearch" , dependeincies = [ Depends ( my_authentication )])
api_router . include_router ( search_routes . router , prefix = "/search" , dependeincies = [ Depends ( my_authentication )])
api_router . include_router ( settings_routes . router , prefix = "/settings" , dependeincies = [ Depends ( my_authentication )])

app . include_router ( api_router )

L'URL de Meilisearch, la météo et une adresse https doivent être utilisées et la clé API est lue à partir des variables d'environnement. Les mettre dans un fichier .env vous évitera d'avoir à définir ces variables à chaque redémarrage du terminal.

MEILI_HTTP_ADDR=localhost:7700  # This is the url for your instance of Meilisearch
MEILI_HTTPS_URL=true  # Setting this specifies the address should be https://. If false or not included the address will be http://
MEILI_MASTER_KEY=masterKey  # This is the API key for your Meilisearch instance

Les itinéraires Meilisearch seront désormais disponibles dans votre application FastAPI. La documentation des itinéraires peut être consultée dans la documentation OpenAPI de l'application FastAPI. Pour afficher cela, démarrez votre application FastAPI et accédez à la documentation http://localhost:8000/docs en remplaçant l'URL par l'URL correcte pour votre application.

Contribuer

Les contributions à ce projet sont les bienvenues. Si vous souhaitez contribuer, veuillez consulter notre guide de contribution