Flask를 이용한 CRUD API 구현 (restful api)

Flask를 이용한 CRUD API 구현 (아이템 관리)

이번 글에서는 Flask와 Flask-RESTful을 사용하여 아이템 관리 API를 구축하는 방법을 다룹니다. 이 API는 아이템 조회, 아이템 생성, 아이템 수정, 아이템 삭제의 CRUD 기능을 제공합니다.

---

1. 전체 코드 설명

from flask import Flask, request
from flask_restful import Api, Resource

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

items = []  # DB의 대체 역할 (간단한 DB 역할)

class Item(Resource):
    
    # 특정 아이템 조회
    def get(self, name):
        for item in items:
            if item['name'] == name:
                return item
        return {"msg": "Item not found"}, 404
    
    # 특정 아이템 생성
    def post(self, name):
        for item in items:
            if item['name'] == name:
                return {"msg": "Item already exists"}, 400
        
        # 특정 아이템 생성
        data = request.get_json()
        item = {'name': name, 'price': data['price']}
        items.append(item)
        return item, 201
                
    # 특정 아이템 업데이트
    def put(self, name):
        data = request.get_json()
        
        for item in items:
            if item['name'] == name:
                item['price'] = data['price']
                return item
            
        # 아이템이 존재하지 않으면 새로운 아이템을 추가
        new_item = {'name': name, 'price': data['price']}
        items.append(new_item)
        return new_item
                
    # 특정 아이템 삭제
    def delete(self, name):
        global items
        items = [item for item in items if item['name'] != name]
        return {'message': 'Item deleted'}
    
api.add_resource(Item, '/item/<string:name>')  # 경로 추가

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

2. 코드 흐름 및 기능 설명

2.1. Flask 애플리케이션과 API 설정

• Flask 앱 생성: app = Flask(__name__)
• Flask-RESTful API 생성: api = Api(app)
• items 리스트는 가상 DB 역할을 하며, 아이템을 저장합니다.

2.2. Item 클래스 (리소스)

이 클래스는 CRUD 기능을 담당하는 리소스를 구현합니다.

• get(self, name):
  • 아이템 조회: 요청된 **name**에 해당하는 아이템을 items 리스트에서 찾습니다.
  • 아이템이 존재하지 않으면 {"msg": "Item not found"}와 404 상태 코드를 반환합니다.
• post(self, name):
  • 아이템 생성: name에 해당하는 아이템이 이미 존재하는지 확인하고, 존재하지 않으면 새로운 아이템을 생성하여 items 리스트에 추가합니다.
  • 아이템이 이미 존재하면 "Item already exists" 메시지와 함께 400 상태 코드를 반환합니다.
• put(self, name):
  • 아이템 업데이트: 요청된 **name**에 해당하는 아이템을 찾고, 그 아이템의 **가격(price)**을 수정합니다.
  • 아이템이 존재하지 않으면 새로운 아이템을 추가합니다.
• delete(self, name):
  • 아이템 삭제: **name**에 해당하는 아이템을 삭제합니다.
  • 아이템을 삭제한 후 {'message': 'Item deleted'} 메시지를 반환합니다.

2.3. API 경로 및 메서드 설정

• api.add_resource(Item, '/item/<string:name>'): /item/<string:name> 경로로 Item 리소스를 추가합니다.
  • <string:name>은 URL 경로 변수로, 클라이언트가 요청할 때 아이템 이름을 전달받습니다.

2.4. Flask 애플리케이션 실행

• if __name__ == '__main__': app.run(debug=True) 부분은 애플리케이션을 실행하는 코드입니다.

---

3. API 테스트 방법

1. GET 요청 (아이템 조회)
   • URL: http://127.0.0.1:5000/item/apple
   • 응답: 아이템 정보가 반환됩니다. 아이템이 없으면 {"msg": "Item not found"}가 반환됩니다.
2. POST 요청 (아이템 생성)
   • URL: http://127.0.0.1:5000/item/apple
   • Body (JSON 형식):

{
    "price": 100
}

•   응답: 새 아이템이 생성되어 {"name": "apple", "price": 100}와 함께 201 상태 코드가 반환됩니다.

1. PUT 요청 (아이템 업데이트)
   • URL: http://127.0.0.1:5000/item/apple
   • Body (JSON 형식):

{
    "price": 150
}

1. • 응답: 아이템 가격이 150으로 업데이트된 데이터가 반환됩니다.
2. DELETE 요청 (아이템 삭제)
   • URL: http://127.0.0.1:5000/item/apple
   • 응답: {"message": "Item deleted"}가 반환됩니다.

---

4. 예시 응답

• GET /item/apple:
  • 응답:

{
  "name": "apple",
  "price": 100
}

• POST /item/apple (새 아이템 생성):
  • 응답:

{
  "name": "apple",
  "price": 100
}

• PUT /item/apple (아이템 업데이트):
  • 응답:

{
  "name": "apple",
  "price": 150
}

• DELETE /item/apple (아이템 삭제):
  • 응답:

{
  "message": "Item deleted"
}

---

5. 결론

이 API는 아이템 조회, 생성, 수정, 삭제를 처리하는 기본적인 CRUD 기능을 구현한 예제입니다. Flask와 Flask-RESTful을 활용하여 간단한 데이터베이스 대체 역할을 하는 items 리스트를 사용하여 데이터를 관리하고 있습니다.

• GET 요청: 아이템 조회
• POST 요청: 아이템 생성
• PUT 요청: 아이템 수정
• DELETE 요청: 아이템 삭제

이를 통해 Flask RESTful API로 기본적인 CRUD 작업을 처리하는 방법을 배울 수 있습니다.

 

1-1. 기능별로 파일로 분리

app.py

from flask import Flask
from flask_restful import Api
from resources.item import Item

app = Flask(__name__)
api = Api(app)
    
api.add_resource(Item, '/item/<string:name>')  # 경로 추가

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

 

resources/item.py

 

from flask import request
from flask_restful import Resource


items = [] # DB의 대체 역할 (간단한 DB 역할)
class Item(Resource):
    
    # 특정 아이템 조회
    def get(self, name):
        
        for item in items:
            if item['name'] == name:
                return item
        return {"msg": "Item not found"}, 404
    
    # 특정 아이템 생성
    def post(self, name):
        
        for item in items:
            if item['name'] == name:
                return {"msg": "Item already exists"}, 400
        
        # 특정 아이템 생성
        data = request.get_json()
        item = {'name':name, 'price': data['price']}
        items.append(item)
        return item, 201
                
    # 특정 아이템 업데이트
    def put(self, name):
        data = request.get_json()
        
        for item in items:
            if item['name'] == name:
                item['price'] = data['price']
                return item
            
        # 아이템이 존재하지 않으면 새로운 아이템을 추가
        new_item = {'name': name, 'price': data['price']}
        items.append(new_item)
        return new_item
                 
            
    
    # 특정 아이템 삭제
    def delete(self, name):
        global items
        items = [item for item in items if item['name'] != name]
        return {'message': 'Item deleted'}