meilisearch fastapi

Meilisearch FastAPI

Meilisearch FastAPI bietet FastAPI-Routen für die Interaktion mit Meilisearch.

Installation

Für die Installation dieses Pakets wird die Verwendung einer virtuellen Umgebung empfohlen. Sobald die virtuelle Umgebung erstellt und aktiviert ist, installieren Sie das Paket mit:

pip install meilisearch-fastapi

Nutzung

Routen werden in Gruppen aufgeteilt, sodass unterschiedliche Abhängigkeiten eingefügt werden können und daher unterschiedliche Zugriffsebenen für verschiedene Gruppen von Routen gewährt werden können.

Beispiel ohne erforderliche Authentifizierung für Routen

 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 )

Beispiel mit Routen, die eine Authentifizierung erfordern

 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 )

Die URL für Meilisearch, eine https-Adresse sollte verwendet werden und der API-Schlüssel wird aus Umgebungsvariablen gelesen. Wenn Sie diese in eine .env-Datei einfügen, müssen Sie diese Variablen nicht bei jedem Neustart des Terminals festlegen.

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

Jetzt sind die Meilisearch-Routen in Ihrer FastAPI-App verfügbar. Die Dokumentation zu den Routen kann in der OpenAPI-Dokumentation der FastAPI-App eingesehen werden. Um dies anzuzeigen, starten Sie Ihre FastAPI-App und navigieren Sie zu den Dokumenten http://localhost:8000/docs und ersetzen Sie die URL durch die richtige URL für Ihre App.

Mitwirken

Beiträge zu diesem Projekt sind willkommen. Wenn Sie daran interessiert sind, einen Beitrag zu leisten, lesen Sie bitte unseren Beitragsleitfaden