SQLite 로 Flask REST API 구축하기 | 프로그래밍 튜토리얼

소개

이 프로젝트에서는 SQLite 를 데이터베이스로 사용하여 Flask 에서 REST API 를 구축하는 방법을 배웁니다. 먼저 샘플 SQLite 데이터베이스를 생성하고 일부 데이터를 채웁니다. 그런 다음, SQLite 데이터베이스의 데이터에 대해 CRUD (Create, Read, Update, Delete) 작업을 수행하는 엔드포인트가 있는 Flask 애플리케이션을 구축합니다.

👀 미리보기

Flask SQLite API 미리보기

🎯 작업

이 프로젝트에서 다음을 배우게 됩니다.

SQLite 를 데이터베이스 백엔드로 사용하여 Flask 애플리케이션을 생성하는 방법
샘플 SQLite 데이터베이스 및 테이블을 생성하는 방법
샘플 데이터로 데이터베이스 테이블을 채우는 방법
모든 사용자를 검색하고, ID 로 특정 사용자를 검색하고, 새 사용자를 생성하고, 기존 사용자를 업데이트하고, 사용자를 삭제하는 엔드포인트를 구현하는 방법
cURL 또는 브라우저를 사용하여 REST API 엔드포인트를 테스트하는 방법

🏆 성과

이 프로젝트를 완료하면 다음을 수행할 수 있습니다.

SQLite 를 데이터베이스로 사용하여 Flask 애플리케이션을 구축
Flask 를 사용하여 SQLite 데이터베이스의 데이터에 대한 CRUD 작업 수행
Flask 애플리케이션용 REST API 엔드포인트 구현 및 테스트

프로젝트 파일 생성

Flask 애플리케이션에 필요한 프로젝트 파일을 생성하는 것으로 시작해 보겠습니다.

~/project 디렉토리로 cd 합니다.
프로젝트 디렉토리 내에서 app.py라는 새 Python 파일을 생성합니다.
같은 디렉토리에 create_database.py라는 새 파일을 생성합니다.

cd ~/project
touch app.py create_database.py

프로젝트 구조는 다음과 같아야 합니다.

project/
├── app.py
└── create_database.py

샘플 SQLite 데이터베이스 생성

다음으로, Python 과 SQLite 라이브러리를 사용하여 SQLite 데이터베이스를 생성하고 샘플 데이터를 채워보겠습니다.

create_database.py 파일에 필요한 모듈을 가져오기 위해 다음 코드를 추가합니다.

import sqlite3

데이터베이스와 테이블을 생성하기 위해 다음 코드를 추가합니다.

## 데이터베이스에 연결을 생성합니다.
conn = sqlite3.connect('example.db')

## SQL 문을 실행하기 위해 커서 객체를 생성합니다.
cursor = conn.cursor()

## "users"라는 테이블을 생성합니다.
cursor.execute('''CREATE TABLE IF NOT EXISTS users (
                    id INTEGER PRIMARY KEY,
                    name TEXT,
                    email TEXT
                )''')

다음으로, 테이블에 몇 가지 샘플 데이터를 삽입해 보겠습니다.

## "users" 테이블에 샘플 데이터를 삽입합니다.
users = [
    ('John Doe', 'johndoe@example.com'),
    ('Jane Smith', 'janesmith@example.com'),
    ('Bob Johnson', 'bobjohnson@example.com')
]
cursor.executemany('INSERT INTO users (name, email) VALUES (?, ?)', users)

## 변경 사항을 데이터베이스에 커밋합니다.
conn.commit()

## 커서와 데이터베이스 연결을 닫습니다.
cursor.close()
conn.close()

cd ~/project
python create_database.py

이 코드를 실행하면 샘플 데이터를 포함하는 "users" 테이블이 있는 example.db라는 SQLite 데이터베이스 파일이 생성됩니다. 이 데이터베이스는 Flask 애플리케이션에서 데이터를 검색하고 조작하는 데 사용됩니다.

Flask 로 REST API 구축

이제 앞에서 생성한 SQLite 데이터베이스 example.db를 사용하여 Flask 에서 REST API 를 구축해 보겠습니다.

app.py 파일에 필요한 모듈을 가져오기 위해 다음 코드를 추가합니다.

from flask import Flask, jsonify, request
import sqlite3

Flask 애플리케이션을 생성하기 위해 다음 코드를 추가합니다.

## Flask 애플리케이션을 생성합니다.
app = Flask(__name__)

이제 REST API 의 엔드포인트를 정의해 보겠습니다.

모든 사용자 검색 엔드포인트

## 모든 사용자 검색 엔드포인트
@app.route('/users', methods=['GET'])
def get_users():
    ## 데이터베이스에 연결합니다.
    conn = sqlite3.connect('example.db')
    cursor = conn.cursor()

    ## 모든 사용자를 검색하는 SQL 쿼리를 실행합니다.
    cursor.execute('SELECT * FROM users')
    users = cursor.fetchall()

    ## 커서와 데이터베이스 연결을 닫습니다.
    cursor.close()
    conn.close()

    ## 사용자를 JSON 으로 반환합니다.
    return jsonify(users)

이 코드에서는 먼저 connect() 메서드를 사용하여 SQLite 데이터베이스에 연결합니다. 그런 다음 cursor() 메서드를 사용하여 SQL 문을 실행하기 위한 커서 객체를 생성합니다. 다음으로 execute() 메서드를 사용하여 "users" 테이블에서 모든 사용자를 검색하는 SQL 쿼리를 실행합니다. 마지막으로 close() 메서드를 사용하여 커서와 데이터베이스 연결을 닫고 jsonify() 메서드를 사용하여 사용자를 JSON 으로 반환합니다.

ID 로 특정 사용자 검색 엔드포인트

## ID 로 특정 사용자 검색 엔드포인트
@app.route('/users/<int:user_id>', methods=['GET'])
def get_user(user_id):
    ## 데이터베이스에 연결합니다.
    conn = sqlite3.connect('example.db')
    cursor = conn.cursor()

    ## ID 로 사용자를 검색하는 SQL 쿼리를 실행합니다.
    cursor.execute('SELECT * FROM users WHERE id = ?', (user_id,))
    user = cursor.fetchone()

    ## 커서와 데이터베이스 연결을 닫습니다.
    cursor.close()
    conn.close()

    ## 사용자가 존재하는지 확인합니다.
    if user:
        return jsonify(user)
    else:
        return jsonify({'message': 'User not found'}), 404

이 엔드포인트는 모든 사용자 대신 ID 로 특정 사용자를 검색한다는 점을 제외하고 이전 엔드포인트와 유사합니다. fetchone() 메서드를 사용하여 "users" 테이블에서 단일 사용자를 검색합니다.

새 사용자 생성 엔드포인트

## 새 사용자 생성 엔드포인트
@app.route('/users', methods=['POST'])
def create_user():
    ## 요청 본문에서 사용자 데이터를 가져옵니다.
    data = request.get_json()
    name = data['name']
    email = data['email']

    ## 데이터베이스에 연결합니다.
    conn = sqlite3.connect('example.db')
    cursor = conn.cursor()

    ## 새 사용자를 삽입하는 SQL 쿼리를 실행합니다.
    cursor.execute('INSERT INTO users (name, email) VALUES (?, ?)', (name, email))
    conn.commit()

    ## 커서와 데이터베이스 연결을 닫습니다.
    cursor.close()
    conn.close()

    ## 성공 메시지를 반환합니다.
    return jsonify({'message': 'User created successfully'})

이 엔드포인트는 "users" 테이블에 새 사용자를 생성하는 데 사용됩니다. get_json() 메서드를 사용하여 요청 본문에서 사용자 데이터를 가져옵니다. 그런 다음 execute() 메서드를 사용하여 새 사용자를 "users" 테이블에 삽입합니다.

기존 사용자 업데이트 엔드포인트

## 기존 사용자 업데이트 엔드포인트
@app.route('/users/<int:user_id>', methods=['PUT'])
def update_user(user_id):
    ## 요청 본문에서 업데이트된 사용자 데이터를 가져옵니다.
    data = request.get_json()
    name = data['name']
    email = data['email']

    ## 데이터베이스에 연결합니다.
    conn = sqlite3.connect('example.db')
    cursor = conn.cursor()

    ## 사용자를 업데이트하는 SQL 쿼리를 실행합니다.
    cursor.execute('UPDATE users SET name = ?, email = ? WHERE id = ?', (name, email, user_id))
    conn.commit()

    ## 커서와 데이터베이스 연결을 닫습니다.
    cursor.close()
    conn.close()

    ## 성공 메시지를 반환합니다.
    return jsonify({'message': 'User updated successfully'})

이 엔드포인트는 "users" 테이블에서 기존 사용자를 업데이트하는 데 사용됩니다. get_json() 메서드를 사용하여 요청 본문에서 업데이트된 사용자 데이터를 가져옵니다. 그런 다음 execute() 메서드를 사용하여 "users" 테이블에서 사용자를 업데이트합니다.

사용자 삭제 엔드포인트

## 사용자 삭제 엔드포인트
@app.route('/users/<int:user_id>', methods=['DELETE'])
def delete_user(user_id):
    ## 데이터베이스에 연결합니다.
    conn = sqlite3.connect('example.db')
    cursor = conn.cursor()

    ## 사용자를 삭제하는 SQL 쿼리를 실행합니다.
    cursor.execute('DELETE FROM users WHERE id = ?', (user_id,))
    conn.commit()

    ## 커서와 데이터베이스 연결을 닫습니다.
    cursor.close()
    conn.close()

    ## 성공 메시지를 반환합니다.
    return jsonify({'message': 'User deleted successfully'})

이 엔드포인트는 "users" 테이블에서 사용자를 삭제하는 데 사용됩니다. execute() 메서드를 사용하여 "users" 테이블에서 사용자를 삭제합니다.

마지막으로, Flask 애플리케이션을 실행하기 위해 다음 코드를 추가해 보겠습니다.

if __name__ == '__main__':
    app.run(debug=True, host='0.0.0.0', port=8080)

Flask 애플리케이션 실행

프로젝트를 실행하고 Flask 애플리케이션을 시작하려면 터미널 또는 명령 프롬프트를 열고 프로젝트 디렉토리로 이동하여 다음 명령을 실행합니다.

cd ~/project
python app.py

다음과 유사한 출력을 볼 수 있습니다.

* Serving Flask app 'app' (lazy loading)
* Environment: production
WARNING: This is a development server. Do not use it in a production deployment.
Use a production WSGI server instead.
* Debug mode: on
* Running on http://0.0.0.0:8080/ (Press CTRL+C to quit)

이는 Flask 애플리케이션이 로컬 머신에서 실행되고 있음을 의미합니다. 이제 cURL 또는 Postman 과 같은 API 테스트 도구를 사용하여 REST API 엔드포인트를 테스트할 수 있습니다.

REST API 엔드포인트 테스트

새 터미널 또는 명령 프롬프트를 엽니다.
다음 cURL 명령을 사용하여 각 엔드포인트를 테스트합니다.

모든 사용자 검색:

curl http://localhost:8080/users

ID 로 특정 사용자 검색 (<user_id>를 실제 사용자 ID 로 바꿉니다):

curl http://localhost:8080/users/<user_id>

새 사용자 생성:

curl -X POST -H "Content-Type: application/json" -d '{"name":"John Doe","email":"johndoe@example.com"}' http://localhost:8080/users

기존 사용자 업데이트 (<user_id>를 실제 사용자 ID 로 바꿉니다):

curl -X PUT -H "Content-Type: application/json" -d '{"name":"Updated Name","email":"updated@example.com"}' http://localhost:8080/users/<user_id>

사용자 삭제 (<user_id>를 실제 사용자 ID 로 바꿉니다):

curl -X DELETE http://localhost:8080/users/<user_id>

해당 엔드포인트를 테스트할 때 <user_id>를 데이터베이스의 실제 사용자 ID 로 바꿔야 합니다.

이러한 cURL 명령을 실행하여 REST API 엔드포인트의 기능을 테스트하고 제대로 작동하는지 확인할 수 있습니다.

또는 Web 8080 탭으로 전환하여 브라우저를 사용하여 REST API 엔드포인트를 테스트할 수 있습니다.

REST API testing interface

이러한 테스트 단계를 통해 Flask 애플리케이션과 해당 REST API 엔드포인트가 예상대로 작동하는지 확인할 수 있습니다.

요약

이 프로젝트에서는 SQLite 를 데이터베이스로 사용하여 Flask 에서 REST API 를 구축하는 방법을 배웠습니다. 샘플 SQLite 데이터베이스를 생성하고 데이터를 채웠습니다. 그런 다음, 데이터베이스에서 사용자를 검색, 생성, 업데이트 및 삭제하는 엔드포인트가 있는 Flask 애플리케이션을 구축했습니다. 단계별 지침에 따라 이제 SQLite 데이터베이스와 상호 작용하는 REST API 를 제공하는 기능적인 Flask 애플리케이션을 갖게 됩니다.

SQLite 를 사용한 Flask REST API 구축

소개