Téléchargement de lumi - Téléchargement du code source lumi

lumi

Données du site Web

1.0.0

Télécharger

Lumi?

Lumi est un framework nano pour convertir vos fonctions Python en une API REST sans aucun mal de tête supplémentaire.

Cette bibliothèque est créée en prenant le concept de RPC et mélangé avec des spécifications d'API REST .
Nous devons simplement enregistrer la fonction et il sera disponible en tant qu'API REST.
Serveur Web écrit avec Gunicorn
Le serveur de développement local a fourni un développement rapide et un prototypage.

Installation

pip install lumi

Fonction <-> Mappage API

Comment utiliser?

Créons une fonction simple pour ajouter deux nombres.

 def add ( a , b ):
    return a + b

def subtract ( a , b ):
    return a - b

Maintenant, nous voulons exposer cette fonction comme une API REST. Nous pouvons le faire en enregistrant la fonction avec Lumi.

 # app.py

from lumi import Lumi

app = Lumi ()

app . register ( add ) # Registering the function
app . register ( subtract )

app . runServer ( host = "127.0.0.1" , port = 8080 )

NOICE ?? L'API a été générée

Courir de la grave

 python app.py

Vous allez voir cela dans votre terminal

 [2022-11-24 17:32:08 +0530] [10490] [INFO] Starting gunicorn 20.1.0
[2022-11-24 17:32:08 +0530] [10490] [INFO] Listening at: http://127.0.0.1:8080 (10490)
[2022-11-24 17:32:08 +0530] [10490] [INFO] Using worker: sync
[2022-11-24 17:32:08 +0530] [10492] [INFO] Booting worker with pid: 10492
...
...
[2022-11-24 17:32:08 +0530] [10500] [INFO] Booting worker with pid: 10500

Félicitations ?. Notre serveur est en ligne.

Le code ci-dessus générera une API REST avec les détails suivants.

Point de terminaison: 127.0.0.1:8080
Route: /add
Méthode: POST
Exemple de corps de demande: {"a": 1, "b": 2}

Exécutons l'API et testons-le.

 curl -X POST -H "Content-Type: application/json" -d '{"a": 1, "b": 2}' http://127.0.0.1:8080/add

Sortir

{
    "exit_code" : 0 , 
    "status_code" : 200 , 
    "result" : 3 , 
    "error" : " "
}

Routage personnalisé

Maintenant, vous pensez peut-être que le nom de la fonction sera toujours le même que l'itinéraire. Mais, vous pouvez modifier l'itinéraire en passant le paramètre de l'itinéraire.

 app . register ( add , route = "/addition" )

Méthode de demande personnalisée

Par défaut, la méthode de demande est POST . Mais, vous pouvez le changer en passant le paramètre de la méthode. Actuellement, il prend en charge les méthodes GET , POST , PUT et PATCH .

 from lumi import Lumi , RequestMethod

app = Lumi ()

def add ( a , b ):
    return a + b

# Default : Register function for POST method
app . register ( add )
# Register function for GET method
app . register ( add , request_method = RequestMethod . GET )
# Register function for POST method
app . register ( add , request_method = RequestMethod . POST )
# Register function for PUT method
app . register ( add , request_method = RequestMethod . PUT )
# Register function for PATCH method
app . register ( add , request_method = RequestMethod . PATCH )

app . runServer ()

? Faites attention avant d'utiliser la demande de Get: si vous utilisez la méthode GET

Vous devez passer les paramètres dans la chaîne de requête, car GET ne prend pas en charge le corps de la demande.
Tous ces arguments, qui seront transmis à la fonction seront au format de chaîne . Alors veillez à les convertir au type souhaité dans votre fonction.

Envoyer un fichier

Envoyer un fichier à l'utilisateur en renvoyant l'objet de fichier.

 from lumi import Lumi , RequestMethod
app = Lumi ()

def download_file ():
    return open ( "file.txt" , "rb" ) # Return file object

app . register ( download_file )

Mode de débogage

Par défaut, le mode de débogage est True . Mais, vous pouvez le changer en passant le paramètre de débogage.

 # app.py

from lumi import Lumi

app = Lumi ( debug = False )
...

Codes d'état

Code d'état	Description
200	Demandez avec succès et aucune erreur ne s'est produite lors de l'exécution de la fonction
500	La demande a été reçue mais il y a eu une erreur pendant l'exécution de la fonction
400	Mauvaise demande (raison possible - les paramètres requis pour la fonction n'ont pas fourni)
405	Méthode non autorisée (Lumi prend en charge uniquement la demande de post )
404	L'itinéraire n'a aucune fonction associée à cela