meilisearch fastapi

Meilisearch FastAPI

Meilisearch FastAPI menyediakan rute FastAPI untuk berinteraksi dengan Meilisearch.

Instalasi

Disarankan menggunakan lingkungan virtual untuk menginstal paket ini. Setelah lingkungan virtual dibuat dan diaktifkan, instal paket dengan:

pip install meilisearch-fastapi

Penggunaan

Rute dibagi menjadi beberapa kelompok sehingga ketergantungan yang berbeda dapat dimasukkan, dan oleh karena itu tingkat akses yang berbeda, dapat diberikan ke kelompok rute yang berbeda.

Contoh tanpa otentikasi diperlukan untuk rute

 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 )

Contoh dengan rute yang memerlukan otentikasi

 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 )

Url untuk Meilisearch, apakah alamat https harus digunakan, dan kunci API dibaca dari variabel lingkungan. Memasukkannya ke dalam file .env akan menghindarkan Anda dari keharusan mengatur variabel-variabel ini setiap kali terminal di-restart.

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

Sekarang rute Meilisearch akan tersedia di aplikasi FastAPI Anda. Dokumentasi rute dapat dilihat di dokumentasi OpenAPI pada aplikasi FastAPI. Untuk melihatnya, mulai aplikasi FastAPI Anda dan navigasikan ke dokumen http://localhost:8000/docs dan ganti url dengan url yang benar untuk aplikasi Anda.

Berkontribusi

Kontribusi untuk proyek ini sangat diharapkan. Jika Anda tertarik untuk berkontribusi, silakan lihat panduan berkontribusi kami