Python 및 Flask로 API 오류 메시지 반환

Question

Python 및 Flask를 사용하여 RESTful API를 설계하고 있습니다. 예상대로 API는 API 요청을 수신하고 모두 정상적으로 처리되면 데이터를 반환해야하지만 오류가 발생하면 오류가 발생하지 않도록 적절하게 오류를 반환해야합니다. 오류가 발생하면 일반적으로 예외를 발생 시키지만이 경우 사용자에게 오류 메시지를 반환해야합니다 (try-catch 블록?).

현재 오류를 처리하는 방법은 데이터와 오류를 모두 반환하고 각 수준에서 데이터를 확인하고 마지막으로 데이터 또는 오류를 API 함수의 호출자에게 반환하는 것입니다 .

이 문제는 여러 수준의 함수 호출이있을 때 번거롭기 때문에 데이터와 오류를 여러 번 전달하고 매번 검사를 수행해야합니다.

더 좋은 방법이 있나요? 오류 전파를 좀 더 간단하고 우아하게 만들기 위해 내가 할 수있는 개선점은 무엇입니까?

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

당신은 클라이언트에 적절한 HTTP 코드를 반환하는 abort(http_code)를 사용하거나 비에 http 예외를 발생시킬 수있다 : 여기

내가 현재 오류를 반환하고있어 방법의 예입니다. @app.errorhandler() 데코레이터를 사용하여 http 오류 및 임의의 예외에 대한 사용자 지정 처리기를 제공하십시오. 또한 예외를 처리 할 준비가 된 일반 try/except 블록을 사용할 수도 있습니다. 파이썬은 예외가 아닙니다.

Answer 2

Flask API이 RESTful API 용으로 특별히 설계되어있어 필요에 따라 더 적합 할 수도 있습니다.

플라스크보다 예외 처리가 더 좋습니다. http://www.flaskapi.org/api-guide/exceptions/