[python] Flask-RESTful에서 사용자 생성과 관리 방법

30 Nov 2023

python

이 문서에서는 Flask-RESTful을 사용하여 사용자를 생성하고 관리하는 방법에 대해 알아보겠습니다. Flask-RESTful은 RESTful 아키텍처를 따르는 웹 API를 쉽게 구현할 수 있는 Flask 확장 프레임워크입니다. 이를 사용하여 사용자를 생성하고 관리하는 API를 만들어 보겠습니다.

사용자 모델 정의하기

먼저, 사용자 모델을 정의해야 합니다. 사용자 모델은 데이터베이스에 사용자 정보를 저장하기 위한 테이블입니다. 예를 들어, 사용자의 이름, 이메일 및 암호화된 비밀번호를 저장할 수 있습니다. 다음은 간단한 사용자 모델의 예입니다:

from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(50), unique=True, nullable=False)
    email = db.Column(db.String(120), unique=True, nullable=False)
    password = db.Column(db.String(128), nullable=False)

위의 코드에서는 Flask-RESTful에서 사용할 SQLAlchemy를 이용하여 데이터베이스 모델을 정의합니다. User 클래스는 사용자 모델을 나타내며, 각각의 속성은 해당 데이터베이스 열에 매핑되어 있습니다.

사용자 생성 API 구현하기

이제 사용자 생성을 위한 API를 구현해보겠습니다. Flask-RESTful은 HTTP 메서드(POST, GET, DELETE 등)를 사용하여 원하는 기능을 정의할 수 있는데, 사용자 생성을 위해서는 POST 메서드를 사용하면 됩니다. 다음은 사용자 생성을 위한 API 예제입니다:

from flask import Flask, request
from flask_restful import Resource, Api
from werkzeug.security import generate_password_hash

app = Flask(__name__)
api = Api(app)

class UserResource(Resource):
    def post(self):
        username = request.json['username']
        email = request.json['email']
        password = request.json['password']

        hashed_password = generate_password_hash(password)

        # 데이터베이스에 사용자 정보 저장
        user = User(username=username, email=email, password=hashed_password)
        db.session.add(user)
        db.session.commit()

        return {'message': 'User created successfully'}

api.add_resource(UserResource, '/users')

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

위의 코드에서는 UserResource라는 Flask-RESTful 리소스 클래스를 정의하고, post 메서드를 사용하여 사용자 생성 기능을 구현합니다. 클라이언트로부터 전송된 사용자 정보를 받아와서 데이터베이스에 저장한 후, 성공 메시지를 반환합니다.

사용자 관리 API 구현하기

사용자를 생성한 후에는 사용자 관리를 위한 API를 구현해야 합니다. 예를 들어, 사용자 정보 조회, 수정 및 삭제 기능을 제공할 수 있습니다. 다음은 사용자 관리를 위한 API 예제입니다:

class UserDetailsResource(Resource):
    def get(self, user_id):
        # 데이터베이스에서 사용자 정보 조회
        user = User.query.get(user_id)
        if not user:
            return {'message': 'User not found'}, 404

        # 사용자 정보 반환
        return {'username': user.username, 'email': user.email}

    def put(self, user_id):
        # 데이터베이스에서 사용자 정보 조회
        user = User.query.get(user_id)
        if not user:
            return {'message': 'User not found'}, 404

        # 클라이언트로부터 전송된 사용자 정보 업데이트
        user.username = request.json.get('username', user.username)
        user.email = request.json.get('email', user.email)
        db.session.commit()

        # 업데이트된 사용자 정보 반환
        return {'message': 'User updated successfully'}

    def delete(self, user_id):
        # 데이터베이스에서 사용자 정보 조회
        user = User.query.get(user_id)
        if not user:
            return {'message': 'User not found'}, 404

        # 사용자 정보 삭제
        db.session.delete(user)
        db.session.commit()

        return {'message': 'User deleted successfully'}

api.add_resource(UserDetailsResource, '/users/<int:user_id>')

위의 코드에서는 UserDetailsResource라는 Flask-RESTful 리소스 클래스를 정의하고, get, put, delete 메서드를 사용하여 사용자 정보 조회, 수정, 삭제 기능을 구현합니다. user_id 파라미터를 이용하여 특정 사용자의 정보를 조회 또는 수정할 수 있습니다.

결론

이 문서에서는 Flask-RESTful을 사용하여 사용자 생성과 관리를 위한 API를 구현하는 방법에 대해 알아보았습니다. Flask-RESTful은 간단하고 효율적인 웹 API 개발을 위한 매우 유용한 도구입니다. 사용자 모델을 정의하고 API를 구현하여 원하는 사용자 관리 기능을 제공할 수 있습니다.

참고 자료: