[파이썬] RESTful API를 위한 에러 처리

04 Sep 2023

python

RESTful API를 개발할 때는 예외 상황이 발생할 수 있습니다. 이러한 예외 상황들을 적절히 처리해주는 것은 안정적인 API를 구축하는 데 중요한 요소입니다. 이 글에서는 Python을 사용하여 RESTful API에서 발생하는 에러를 처리하는 방법에 대해 알아보겠습니다.

HTTP 상태 코드

RESTful API에서 가장 일반적으로 사용되는 방법은 HTTP 상태 코드를 사용하는 것입니다. HTTP 상태 코드는 서버에서 클라이언트로 요청 처리 결과를 전달하는 데 사용됩니다. 몇 가지 일반적인 상태 코드는 다음과 같습니다:

200: OK
201: Created
400: Bad Request
401: Unauthorized
404: Not Found
500: Internal Server Error

이러한 상태 코드는 애플리케이션에서 발생하는 예외 상황에 따라 다양하게 사용됩니다. 예를 들어, 클라이언트가 잘못된 요청을 보낸 경우에는 400 상태 코드를 반환하고, 요청한 리소스를 찾을 수 없는 경우에는 404 상태 코드를 반환할 수 있습니다.

Flask를 사용한 예외 처리

Flask는 Python에서 RESTful API를 개발하기 위해 일반적으로 사용되는 프레임워크입니다. Flask를 사용하여 예외 상황을 적절하게 처리하는 방법을 살펴보겠습니다.

먼저, Flask 앱에서 에러 핸들러를 등록합니다. 이 핸들러는 발생한 예외를 캐치하여 적절한 HTTP 상태 코드와 함께 클라이언트에 응답을 보내는 역할을 담당합니다.

from flask import Flask, jsonify, abort

app = Flask(__name__)

@app.errorhandler(400)
def bad_request(error):
    return jsonify({'message': 'Bad Request'}), 400

@app.errorhandler(404)
def not_found(error):
    return jsonify({'message': 'Not Found'}), 404

@app.route('/users/<int:user_id>', methods=['GET'])
def get_user(user_id):
    if not user_exists(user_id):
        abort(404)
    return jsonify({'user_id': user_id, 'name': 'John Doe'})

def user_exists(user_id):
    # 사용자가 존재하는지 확인하는 로직
    pass

if __name__ == '__main__':
    app.run()

위의 예제에서는 @app.errorhandler 데코레이터를 사용하여 400과 404 상태 코드에 대한 예외 핸들러를 등록했습니다. 예외가 발생하면 해당 핸들러가 호출되고, 클라이언트에게 적절한 상태 코드와 함께 JSON 응답을 보냅니다.

get_user 메서드에서는 사용자의 존재 여부를 확인하고, 존재하지 않는 경우 abort(404)를 호출하여 404 상태 코드를 반환합니다.

커스텀 예외 처리

Flask에서는 커스텀 예외 클래스를 만들어 예외 처리를 더욱 간결하게 할 수도 있습니다. 예를 들어, 특정 조건을 만족하지 않을 때 400 상태 코드를 반환하는 커스텀 예외 클래스를 만들 수 있습니다.

from flask import Flask, jsonify

app = Flask(__name__)

class BadRequest(Exception):
    pass

@app.errorhandler(BadRequest)
def handle_bad_request(error):
    return jsonify({'message': 'Bad Request'}), 400

@app.route('/users/<int:user_id>', methods=['GET'])
def get_user(user_id):
    if not user_exists(user_id):
        raise BadRequest()
    return jsonify({'user_id': user_id, 'name': 'John Doe'})

def user_exists(user_id):
    # 사용자가 존재하는지 확인하는 로직
    pass

if __name__ == '__main__':
    app.run()

위 예제에서는 BadRequest라는 커스텀 예외 클래스를 정의하고, handle_bad_request 함수에서 이 예외를 처리합니다. get_user 메서드에서는 사용자가 존재하지 않는 경우 BadRequest 예외를 발생시키고, 핸들러가 이 예외를 잡아서 400 상태 코드를 반환합니다.

요약

RESTful API에서 발생하는 예외 상황을 적절하게 처리하는 것은 안정적인 API를 구축하는 데 필수적입니다. HTTP 상태 코드를 사용하여 예외 상황을 표현하고, Flask와 같은 프레임워크를 사용하여 쉽게 처리할 수 있습니다. 커스텀 예외 클래스를 만들어서 예외 처리를 더욱 간결하고 유연하게 할 수도 있습니다.