Descargar lumi - Descargar el código fuente de lumi

lumi

Datos del sitio web

1.0.0

Descargar

Lumi?

Lumi es un marco nano para convertir sus funciones de Python en una API REST sin ningún dolor de cabeza adicional.

Esta biblioteca se crea tomando el concepto de RPC y se combina con las especificaciones de API REST .
Solo necesitamos registrar la función y estará disponible como API REST.
Servidor web escrito con Gunicorn
El servidor de desarrollo local proporcionó un desarrollo rápido y creación de prototipos.

Instalación

pip install lumi

Función <-> Mapeo de API

¿Cómo usar?

Creemos una función simple para agregar dos números.

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

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

Ahora, queremos exponer esta función como una API REST. Podemos hacer esto registrando la función con 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 ?? Se ha generado API

Correr por

 python app.py

Vas a ver esto en tu 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

¿Felicidades?. Nuestro servidor está en línea.

El código anterior generará una API REST con los siguientes detalles.

Punto final: 127.0.0.1:8080
Ruta: /add
Método: POST
Muestra de cuerpo de solicitud: {"a": 1, "b": 2}

Ejecutemos la API y pruebemos.

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

Producción

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

Enrutamiento personalizado

Ahora puede pensar, el nombre de la función siempre será el mismo que la ruta. Pero, puede cambiar la ruta pasando el parámetro de ruta.

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

Método de solicitud personalizada

Por defecto, el método de solicitud es POST . Pero, puede cambiarlo pasando el parámetro del método. Actualmente, admite métodos GET , POST , PUT y 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 ()

? Preste atención antes de usar la solicitud Get: si está utilizando el método GET

Debe pasar los parámetros en la cadena de consulta, ya que GET el cuerpo de la solicitud de no admitir.
Todos esos argumentos que se pasarán a la función estarán en formato de cadena . Así que tenga cuidado de convertirlos al tipo deseado en su función.

Enviar archivo

Envíe el archivo al usuario devolviendo el objeto de archivo.

 from lumi import Lumi , RequestMethod
app = Lumi ()

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

app . register ( download_file )

Modo de depuración

Por defecto, el modo de depuración es True . Pero, puede cambiarlo pasando el parámetro de depuración.

 # app.py

from lumi import Lumi

app = Lumi ( debug = False )
...

Códigos de estado

Código de estado	Descripción
200	Solicitud ejecutada con éxito y no ocurrió ningún error durante la ejecución de la función
500	Se recibió la solicitud, pero hubo un error durante la ejecución de la función
400	Mala solicitud (posible razón: los parámetros requeridos para la función no han proporcionado)
405	Método no permitido (Lumi solo admite la solicitud posterior )
404	La ruta no tiene función asociada con eso