Ubuntu에서 Flask로 REST API 생성

개 introduction

이 튜토리얼에서는 Flask, lightweight Python web framework를 사용하여 간단한 REST API를 만들 수 있는 방법을 배울 것입니다. 우리는 Flask 应用程序을 설정하는 기본적인 것들, 라우트를 정의하고, 요청을 처리하고, JSON 응답을 돌려주는 것을 다룹니다. 이 튜토리얼이 끝나면, 확장하고 다른 应用程序과 인tegrate 할 수 있는 작동하는 API를 가지게 될 것입니다.

Prerequisites

• Ubuntu를 실행하는 서버와 sudo 기능을 가진 non-root user를 가지고 있습니다. 이러한 구성을 위한 지침은 이 목록에서 자신의 배포를 선택하고 우리의 초기 서버 설정 안내서를 따라하십시오. Ubuntu의 지원 version을 사용하여 일하십시오.

• Linux 명령 행에 대한 熟悉성이 있음을 가정합니다. Linux 명령 행에 대한 소개 또는 훅업을 얻으시려면, Linux command line primer 에 대한 이 가이드를 방문할 수 있습니다.

• Python 프로그래밍에 대한 기본적인 이해를 가지고 있음을 가정합니다.

• Python 3.7 이상의 버전을 설치하고 있는지 확인하십시오. Ubuntu 上调用 Python 스크립트에 대한 指导을 얻으시려면, How to run a Python script on Ubuntu에 대한 我们的 튜orial을 参照할 수 있습니다.

단계 1 — Flask 환경 세팅

Ubuntu 24.04는 기본적으로 Python 3를 설치합니다. 터미널을 열고 다음 명령어를 실행하여 Python 3의 설치 여부를 다시 확인하세요:

root@ubuntu:~# python3 --version
Python 3.12.3

Python 3이 이미 您的 컴퓨터에 설치되었다면, 위 명령어는 Python 3의 현재 버전을 리턴합니다. 설치되지 않은 경우, 다음 명령어를 실행하여 Python 3을 설치할 수 있습니다:

root@ubuntu:~# sudo apt install python3

次に, 시스템에 pip 패키지 설치기를 설치해야 합니다:

root@ubuntu:~# sudo apt install python3-pip

一旦 pip 가 설치되었으면, Flask를 安装하겠습니다.

이제 Flask를 pip 를 이용해 安装할 것입니다. 시스템의 다른 패키지와 충돌을 避ける ために, 가상 환경에서 이 操作을 수행하는 것이 좋습니다.

root@ubuntu:~# python3 -m venv 마이프로젝트env
root@ubuntu:~# source 마이프로젝트env/bin/activate

root@ubuntu:~# pip install Flask

Step 2 – Flask 应用程序 만들기

다음 단계는 Flask 应用程序의 Python 코드를 쓰는 것입니다. 새 스크립트를 만들기 위해서는 你的 스크립트 디렉터리에 导航하십시오:

root@ubuntu:~# cd ~/path-to-your-script-directory

디렉터리 안에 있으면, 新的 Python 파일 app.py을(를) 만들고 Flask을 導入하십시오. 그 다음, Flask 应用程序을 초기화하고 기본적인 路线을 만듭니다.

root@ubuntu:~# nano app.py

이것이 공백 텍스트 에디터를 열게 합니다. 여기에 你的 로직을 쓰거나 다음 코드를 복사하십시오:

from flask import Flask, jsonify, request

app = Flask(__name__)

@app.route('/')
def hello_world():
    return jsonify(message="Hello, World!")

# 인메모리 데이터 저장소
items = [{"id": 1, "name": "This is item 1"}, {"id": 2, "name": "This is item 2"}]

Step 3 — RESTful 路线 만들기

이 部分에서, Flask 应用程序에 대응하는 路线을 정의하고, API에 대해 사용자가 수행할 수 있는 다양한 행위를 처리합니다. 각 路线은 특정 HTTP 方法을 처리하게 됩니다.

plaintext
GET, POST, PUT, 그리고 DELETE. 이 메소드는 영속 저장소의 네 가지 기본 연산—CRUD(생성, 조회, 업데이트, 삭제)로ufig 참조되는 것들과 일치합니다.

다음 경로를 app.py 파이썬 스크립트에 추가하세요:

from flask import Flask, jsonify, request

app = Flask(__name__)

@app.route('/')
def hello_world():
    return jsonify(message="Hello, World!")

# 메모리 내 데이터 저장소
items = [{"id": 1, "name": "This is item 1"}, {"id": 2, "name": "This is item 2"}]

# GET 요청: 모든 항목 가져오기
@app.route('/api/items', methods=['GET'])
def get_items():
    return jsonify(items)

# GET 요청: ID로 특정 항목 가져오기
@app.route('/api/items/<int:item_id>', methods=['GET'])
def get_item(item_id):
    item = next((item for item in items if item["id"] == item_id), None)
    if item is None:
        return jsonify({"error": "Item not found"}), 404
    return jsonify(item)

# POST 요청: 새 항목 생성
@app.route('/api/items', methods=['POST'])
def create_item():
    new_item = {"id": len(items) + 1, "name": request.json.get('name')}
    items.append(new_item)
    return jsonify(new_item), 201

# PUT 요청: 기존 항목 업데이트
@app.route('/api/items/<int:item_id>', methods=['PUT'])
def update_item(item_id):
    item = next((item for item in items if item["id"] == item_id), None)
    if item is None:
        return jsonify({"error": "Item not found"}), 404
    item['name'] = request.json.get('name', item['name'])
    return jsonify(item)

# DELETE 요청: 항목 삭제
@app.route('/api/items/<int:item_id>', methods=['DELETE'])
def delete_item(item_id):
    global items
    items = [item for item in items if item["id"] != item_id]
    return '', 204

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

각 기능이 하는 일을 더 자세히 알아봅시다:

• Flask 임포트: 코드는 Flask에서 필요한 구성 요소를 임포트합니다: Flask, jsonify, 그리고 request.

• 메모리 내 데이터 저장소: items는 API의 임시 데이터 저장소로서 동작하는 사전 리스트입니다. 각 항목은 id와 name을 가지고 있습니다.

• GET /api/items: GET 요청이 /api/items로 실행되면, 서버는 아이템 데이터 저장소에 있는 모든 아이템 목록을 반환합니다. 이것은 コレク션内のすべてのリソースを取得するために 유용합니다.

• POST /api/items: /api/items로 POST 요청을 할 수 있으며, 이를 통해 클라이언트는 새로운 아이템을 생성할 수 있습니다. 서버는 요청 obyect에 새로운 아이템의 자세한 정보가 포함된 JSON 오브젝트를 기대합니다. 아이템을 생성한 후, 서버는 새로 생성한 아이템과 201 Created 상태 코드를 반환합니다.

• PUT /api/items/<int:item_id>: PUT 요청을 /api/items/<item_id>로 할 수 있으며, 이를 통해 지정된 item_id를 갖는 기존 아이템을 갱신할 수 있습니다. 클라이언트는 갱신后的 데이터를 요청 obyect에 보냅니다. 기존의 아이템이 없다면, 서버는 404 Not Found 에러를 반환합니다.

• DELETE /api/items/>: DELETE 요청 /api/items/>는 지정 item_id의 항목을 데이터 저장소에서 제거합니다. 항목이 성공적으로 지워지면, 서버는 204 No Content 상태 코드를 반응하여 제거가 성공적이었고 더 이상 내용을 리턴하지 않는다고 나타냅니다.

• Application 실행: if __name__ == "__main__": 블록은 스크립트가 직접 실행되었을 때 Flask 응용 프로그램이 실행되는 것을 보장합니다.

스텝 4 – API 실행 및 테스트

다음 명령을 사용하여 Flask 서버를 시작합니다:

root@ubuntu:~# python3 app.py

Flask 서버가 다음 출력과 함께 실행되는 것을 알 수 있어야 합니다:

Output
* Serving Flask app 'app'
 * Debug mode: on
WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
 * Running on http://127.0.0.1:5000
Press CTRL+C to quit
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 837-877-972

위 출력에서 서버가 http://127.0.0.1에서 실행되고 5000번 포트에서 수신 대기 중임을 알 수 있습니다.

이제 curl, Postman, 또는 다른 HTTP 클라이언트를 사용하여 엔드포인트를 테스트할 수 있습니다. 이 자습서에서는 curl을 사용하여 엔드포인트를 테스트하고 HTTP 요청을 보낼 것입니다.

Ubuntu 콘솔을 다른 하나 열고 다음 curl 명령을 하나씩 실행합니다:

• GET: curl http://127.0.0.1:5000/api/items
• POST: curl -X POST -H "Content-Type: application/json" -d '{"name": "This is item 3"}' http://127.0.0.1:5000/api/items
• PUT: curl -X PUT -H "Content-Type: application/json" -d '{"name": "This is updated item 1"}' http://127.0.0.1:5000/api/items/1
• DELETE: curl -X DELETE http://127.0.0.1:5000/api/items/1

이러한 명령들을 실제로 실행해봅시다:

root@ubuntu:~# curl http://127.0.0.1:5000/api/items

Output
[
  {
    "id": 1,
    "name": "This is item 1"
  },
  {
    "id": 2,
    "name": "This is item 2"
  }
]

그 서버는 아이템 데이터 스토어에 모든 아이템의 목록을 리턴합니다.

POST 메서드를 사용하여 데이터 스토어에 새 아이템을 추가하도록 합니다.

root@ubuntu:~# curl -X POST -H "Content-Type: application/json" -d '{"name": "This is item 3"}' http://127.0.0.1:5000/api/items

Output
{
  "id": 3,
  "name": "This is item 3"
}

* Running on http://127.0.0.1:5000
Press CTRL+C to quit
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 837-877-972
127.0.0.1 - - [23/Aug/2024 06:57:27] "GET /api/items HTTP/1.1" 200 -
127.0.0.1 - - [23/Aug/2024 06:59:56] "POST /api/items HTTP/1.1" 201 -

다음에는 PUT 요청을 실행합니다. /api/items/<item_id>에 대한 PUT 요청은 지정된 item_id로 기존 아이템을 更新합니다.

root@ubuntu:~# curl -X PUT -H "Content-Type: application/json" -d '{"name": "This is updated item 1"}' http://127.0.0.1:5000/api/items/1

Output
{
  "id": 1,
  "name": "This is updated item 1"
}

이제, 更新된 아이템 1의 정보를 보기 위한 GET 요청을 실행합니다.

root@ubuntu:~# curl http://127.0.0.1:5000/api/items/1

Output
{
  "id": 1,
  "name": "This is updated item 1"
}

마지막으로, 데이터 스토어에서 아이템을 지우기 위한 DELETE 요청을 실행합니다.

root@ubuntu:~# curl -X DELETE http://127.0.0.1:5000/api/items/1

이 요청은 아이템 1을 데이터 스토어에서 지웁니다.

이를 확인하기 위해 GET 요청을 실행합니다.

root@ubuntu:~# curl http://127.0.0.1:5000/api/items

Output
[
  {
    "id": 2,
    "name": "This is item 2"
  },
  {
    "id": 3,
    "name": "This is item 3"
  }
]

아이템 1은 더 이상 存在하지 않으며 永久的に 제거되었습니다.

결론

이 튜토리얼에서는 Flask을 사용하여 기본 REST API 어플리케이션을 만들었습니다. 이제 이 API를 추가적인 ルーTE로 확장하거나 데이터베이스와 통합하거나 DigitalOcean과 같은 클라우드 platfrom에 배포할 수 있습니다. Flask은 API를 快速하고 효율적으로 만들기 위한 強力한 도구입니다. 이 기본 지식으로 더 複雑한 응용 프로그램을 시작해 보실 수 있습니다.