meilisearch fastapi

Meilisearch FastAPI

Meilisearch FastAPI fornece rotas FastAPI para interagir com Meilisearch.

Instalação

O uso de um ambiente virtual é recomendado para instalar este pacote. Depois que o ambiente virtual for criado e ativado, instale o pacote com:

pip install meilisearch-fastapi

Uso

As rotas são divididas em grupos para que diferentes dependências possam ser injetadas e, portanto, diferentes níveis de acesso possam ser dados a diferentes grupos de rotas.

Exemplo sem autenticação necessária para rotas

 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 )

Exemplo com rotas que requerem autenticação

 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 )

O URL do Meilisearch, um endereço https deve ser usado e a chave da API é lida nas variáveis ​​de ambiente. Colocá-los em um arquivo .env evitará que você precise definir essas variáveis ​​toda vez que o terminal for reiniciado.

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

Agora as rotas Meilisearch estarão disponíveis em seu aplicativo FastAPI. A documentação das rotas pode ser visualizada na documentação OpenAPI do aplicativo FastAPI. Para visualizar isso, inicie seu aplicativo FastAPI e navegue até os documentos http://localhost:8000/docs substituindo o URL pelo URL correto para seu aplicativo.

Contribuindo

Contribuições para este projeto são bem-vindas. Se você estiver interessado em contribuir, consulte nosso guia de contribuição