MeiliSearch FastAPI
MeiliSearch FastAPI provides FastAPI routes for interacting with MeiliSearch.
Installation
Using a virtual environmnet is recommended for installing this package. Once the virtual environment is created and activated install the package with:
pip install meilisearch-fastapi
Useage
Routes are split in groups so that different dependencies can be injected, and therefore different levels of access, can be given to different groups of routes.
Example with no authentication require for routes
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)
Example with routes requiring authentication
from fastapi import APIRouter, FastAPI
from meilisearch_fastapi import 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)
The url for MeiliSearch and API key are read from environment variables. Putting these into a .env file will keep you from having to set these variables each time the terminal is restarted.
MEILISEARCH_URL=http://localhost:7700 # This is the url for your instance of MeiliSearch
MEILISEARCH_API_KEY=masterKey # This is the API key for your MeiliSearch instance
Now the MeiliSearch routes will be available in your FastAPI app. Documentation for the routes can be viewed in the OpenAPI documentation of the FastAPI app. To view this start your FastAPI app and naviate to the docs http://localhost:8000/docs replacing the url with the correct url for your app.
Compatibility with MeiliSearch
This package only guarantees the compatibility with version v0.23 of MeiliSearch.
Contributing
Contributions to this project are welcome. If you are interesting in contributing please see our contributing guide
249 Jan 2, 2023
1.1k Jan 5, 2023
950 Jan 8, 2023
48 Mar 7, 2022
52 Jan 3, 2023
4 Jan 20, 2022
1 Nov 7, 2021
2 Nov 28, 2021
5 Sep 12, 2022
0 Dec 27, 2021
1 Jan 17, 2022
8 Dec 1, 2022
14 Dec 18, 2022
219 Oct 3, 2022
24 Dec 29, 2020