Devolver mensajes de error de API con Python y Flask

Question

Estoy diseñando una API RESTful utilizando Python y Flask. Como se esperaba, la API necesita recibir una solicitud de API y devolver datos si todo va bien, pero en el caso de un error, debe fallar suavemente y devolver el error adecuado. Normalmente planteo excepciones cuando se produce un error, pero en este caso necesito devolver el mensaje de error al usuario (¿bloque try-catch?).

La forma en que actualmente estoy lidiando con errores es hacer que mis funciones devuelvan los datos y un error, y verificar los datos en cada nivel, finalmente devolviendo los datos o el error a la persona que llama de la función API .

El problema con esto es que puede resultar engorroso cuando hay varios niveles de llamadas a funciones, lo que requiere que mis funciones pasen datos y errores varias veces y realicen comprobaciones cada vez.

¿Hay una mejor manera de hacerlo? ¿Cuáles son algunas mejoras que podría hacer para que la propagación de errores sea más simple y elegante?

Aquí se muestra un ejemplo de la forma en que actualmente estoy volviendo errores:

def get_data() 
    data1, error = get_some_data() # function not shown 
    if data1 is None: 
     return None, "could not retrieve data1" 
    data2, error = get_some_other_data() # function not shown 
    if data2 is None: 
     return None, "could not retrieve data2" 
    return (data1, data2), None 

@app.route("/api/method", methods=['GET']) 
def method(): 
    data, error = get_data() 
    if data is None: 
     if error is None: 
      error = "unknown error" 
     return json.dumps({ "error": error }), 500 
    return json.dumps({ "data": data }), 200 

Answer 1

Usted podría utilizar abort(http_code) a devolver un código http apropiada para el cliente o simplemente levantar una no-http excepción. Y use el decorador @app.errorhandler() para proporcionar un controlador personalizado para errores http y excepciones arbitrarias. También podría usar un bloque try/except ordinario donde esté listo para manejar una excepción. Python no es Ir, puede usar excepciones.

Answer 2

Tal vez el Flask API es más adecuado para sus necesidades, ya que está diseñado especialmente para API RESTful.

Tiene mejor manejo de excepciones de Frasco, consulte: http://www.flaskapi.org/api-guide/exceptions/