meilisearch fastapi

API rápida de Meilisearch

Meilisearch FastAPI proporciona rutas FastAPI para interactuar con Meilisearch.

Instalación

Se recomienda utilizar un entorno virtual para instalar este paquete. Una vez creado y activado el entorno virtual, instale el paquete con:

pip install meilisearch-fastapi

Uso

Las rutas se dividen en grupos para que se puedan inyectar diferentes dependencias y, por lo tanto, se puedan dar diferentes niveles de acceso a diferentes grupos de rutas.

Ejemplo sin necesidad de autenticación para rutas

 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 )

Ejemplo con rutas que requieren autenticación

 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 )

La URL de Meilisearch, si se debe utilizar una dirección https y la clave API se leen desde las variables de entorno. Ponerlos en un archivo .env evitará que tenga que configurar estas variables cada vez que reinicie el 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

Ahora las rutas de Meilisearch estarán disponibles en su aplicación FastAPI. La documentación de las rutas se puede ver en la documentación de OpenAPI de la aplicación FastAPI. Para ver esto, inicie su aplicación FastAPI y navegue a los documentos http://localhost:8000/docs reemplazando la URL con la URL correcta para su aplicación.

Contribuyendo

Las contribuciones a este proyecto son bienvenidas. Si está interesado en contribuir, consulte nuestra guía de contribución.