Python에서 API를 빠르게 구축하는 방법-파이썬 튜토리얼-php.cn

API는 데이터 교환이나 외부 통합에 의존하는 대부분의 애플리케이션의 백본입니다.

Python에서 API를 구축하는 방법을 배우면 앱을 다른 시스템과 연결하고 다목적 백엔드를 만들 수 있는 많은 기회가 열릴 수 있습니다.

여기에서는 API의 기본 사항, REST API 생성, 두 가지 인기 Python 프레임워크인 Flask 및 FastAPI를 사용하여 구축하는 방법을 안내하겠습니다.

1. API 소개

오늘날 디지털 세계에서는 API가 어디에나 있습니다.

이를 통해 서로 다른 시스템과 애플리케이션이 서로 통신하고 데이터와 기능을 원활하게 공유할 수 있습니다.

예를 들어 날씨를 확인하기 위해 앱을 사용할 때 실제로는 날씨 데이터를 반환하는 API를 호출하는 것입니다.

API는 표준화된 방식으로 요청을 처리하고 데이터를 반환하는 중개자 역할을 하여 삶을 더욱 편리하게 만듭니다.

API가 클라이언트 애플리케이션(예: 웹사이트 또는 모바일 앱)만 제공하는 것이 아니라는 점도 주목할 가치가 있습니다.

동일한 인프라 내의 백엔드 시스템이나 마이크로서비스 간에 API를 사용하여 데이터를 보다 효율적으로 관리할 수 있습니다.

2. REST API

REST(Representational State Transfer)는 단순성과 HTTP와의 호환성으로 인해 API를 생성하는 가장 널리 사용되는 방법 중 하나입니다.

RESTful API는 표준 HTTP 메서드(예: GET, POST, PUT, DELETE)를 사용하여 리소스를 조작할 수 있도록 구성되어 있습니다.

각 요청 메소드가 리소스 데이터에 대한 작업을 수행하는 CRUD(생성, 읽기, 업데이트 및 삭제) 작업을 관리하는 데 자주 사용됩니다.

웹 서비스를 구축하는 경우 REST가 가장 접근하기 쉽고 널리 지원되는 형식일 것입니다.

REST API는 상태 비저장(Stateless)입니다. 즉, 각 요청이 독립적으로 작동하므로 REST API를 더 쉽게 확장할 수 있습니다.

3. Flask로 API 구축

Flask는 가볍고 시작 및 실행이 쉽기 때문에 중소 규모 프로젝트에 적합합니다.

Flask를 사용하면 API의 거의 모든 측면을 제어할 수 있지만 데이터 검증 및 오류 처리에 대한 작업이 조금 더 필요합니다.

그러나 이러한 유연성은 API의 각 부분이 작동하는 방식을 더 효과적으로 제어하려는 사람들에게 이상적입니다.

Flask API 생성 예

Flask에서 작업 관리 API를 볼 수 있는 방법은 다음과 같습니다.

먼저 pip를 사용하여 플라스크를 설치해야 합니다.

pip install flask

로그인 후 복사

이 예에서는 작업 가져오기 및 생성은 물론 업데이트 및 삭제를 위한 엔드포인트를 빠르게 설정하는 방법을 보여줍니다.

from flask import Flask, jsonify, request

app = Flask(__name__)

tasks = [
    {"id": 1, "task": "Learn Flask", "done": False},
    {"id": 2, "task": "Build API", "done": False}
]

@app.route('/tasks', methods=['GET'])
def get_tasks():
    return jsonify({"tasks": tasks})

@app.route('/tasks', methods=['POST'])
def create_task():
    new_task = {
        "id": len(tasks) + 1,
        "task": request.json["task"],
        "done": False
    }
    tasks.append(new_task)
    return jsonify(new_task), 201

@app.route('/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
    task = next((task for task in tasks if task["id"] == task_id), None)
    if task:
        return jsonify(task)
    return jsonify({"message": "Task not found"}), 404

@app.route('/tasks/<int:task_id>', methods=['PUT'])
def update_task(task_id):
    task = next((task for task in tasks if task["id"] == task_id), None)
    if task:
        task.update(request.json)
        return jsonify(task)
    return jsonify({"message": "Task not found"}), 404

@app.route('/tasks/<int:task_id>', methods=['DELETE'])
def delete_task(task_id):
    task = next((task for task in tasks if task["id"] == task_id), None)
    if task:
        tasks.remove(task)
        return jsonify({"message": "Task deleted"})
    return jsonify({"message": "Task not found"}), 404

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

로그인 후 복사

이 Python 코드는 Flask를 사용하여 작업 목록을 관리하고 클라이언트가 작업을 생성, 검색, 업데이트 및 삭제할 수 있도록 REST API를 설정합니다.

작업은 각 작업이 ID, 작업 및 완료 상태가 포함된 사전인 목록에 저장됩니다.

/tasks 엔드포인트는 전체 작업 목록을 반환하는 GET 요청과 새 작업을 추가하는 POST 요청을 지원하여 각 작업에 고유한 ID를 자동으로 할당합니다.

추가 엔드포인트인 /tasks/를 사용하면 사용자가 개별 작업과 상호 작용할 수 있습니다. GET은 ID로 특정 작업을 검색하고, PUT는 이를 업데이트하고, DELETE는 목록에서 해당 작업을 제거합니다.

지정된 ID를 가진 작업을 찾을 수 없는 경우 이러한 엔드포인트는 적절한 메시지와 함께 404 오류를 반환합니다.

API는 디버그 모드에서 실행되므로 개발 및 테스트 목적에 적합합니다.

대규모 프로젝트의 경우 구조화된 라우팅 및 검증 메커니즘을 더 추가해야 할 수도 있다는 점에 유의하세요.

4. FastAPI로 API 구축

FastAPI는 성능에 민감한 애플리케이션이나 좀 더 많은 구조와 유형 안전성이 필요한 프로젝트에 탁월한 선택입니다.

FastAPI는 기본적으로(비동기 기능 덕분에) 더 빠르게 설계되었으며 Pydantic을 사용하여 기본적으로 강력한 데이터 검증 기능을 제공합니다.

FastAPI는 매우 직관적이고 작업하기 쉽다는 것을 알았습니다. 특히 비동기 기능이 필요하고 타사 패키지 없이 내장된 유효성 검사를 원하는 프로젝트의 경우 더욱 그렇습니다.

또한 Swagger UI를 통한 자동 문서화 기능으로 매우 편리합니다.

FastAPI API 생성 예

FastAPI에서 작업 관리 API가 표시되는 방식은 다음과 같습니다.

먼저 pip를 사용하여 fastapi와 uvicorn을 설치하는 것을 잊지 마세요.

pip install flask

로그인 후 복사

그런 다음 API를 생성할 수 있습니다.

from flask import Flask, jsonify, request

app = Flask(__name__)

tasks = [
    {"id": 1, "task": "Learn Flask", "done": False},
    {"id": 2, "task": "Build API", "done": False}
]

@app.route('/tasks', methods=['GET'])
def get_tasks():
    return jsonify({"tasks": tasks})

@app.route('/tasks', methods=['POST'])
def create_task():
    new_task = {
        "id": len(tasks) + 1,
        "task": request.json["task"],
        "done": False
    }
    tasks.append(new_task)
    return jsonify(new_task), 201

@app.route('/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
    task = next((task for task in tasks if task["id"] == task_id), None)
    if task:
        return jsonify(task)
    return jsonify({"message": "Task not found"}), 404

@app.route('/tasks/<int:task_id>', methods=['PUT'])
def update_task(task_id):
    task = next((task for task in tasks if task["id"] == task_id), None)
    if task:
        task.update(request.json)
        return jsonify(task)
    return jsonify({"message": "Task not found"}), 404

@app.route('/tasks/<int:task_id>', methods=['DELETE'])
def delete_task(task_id):
    task = next((task for task in tasks if task["id"] == task_id), None)
    if task:
        tasks.remove(task)
        return jsonify({"message": "Task deleted"})
    return jsonify({"message": "Task not found"}), 404

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

로그인 후 복사

이 Python 코드는 데이터 검증 및 유형 적용을 위해 Pydantic 모델을 활용하는 FastAPI를 사용하여 작업 관리 API를 생성합니다.

ID, 작업, 완료 상태로 작업 모델을 정의하고 작업 목록을 초기화합니다.

API에는 작업에 대한 CRUD 작업을 수행하는 엔드포인트가 포함되어 있습니다. /tasks 엔드포인트를 사용하면 GET 요청으로 작업 목록을 검색하고 POST 요청으로 새 작업을 추가하여 수신 데이터의 유효성을 자동으로 확인할 수 있습니다.

/tasks/{task_id} 엔드포인트는 GET으로 특정 작업 검색, PUT으로 업데이트, DELETE로 삭제를 허용하며, 지정된 ID를 가진 작업을 찾을 수 없는 경우 404 오류를 반환합니다.

FastAPI의 비동기 기능과 통합 문서 덕분에 이 API는 효율적이고 테스트하기 쉬우며 신속한 개발에 이상적입니다.

5. API 테스트

테스트는 특히 다른 애플리케이션이 사용할 API를 생성할 때 매우 중요합니다.

Flask와 FastAPI는 단위 테스트에 대한 탁월한 지원을 제공하므로 각 엔드포인트의 동작을 쉽게 확인할 수 있습니다.

테스트를 더 쉽게 하려면 Flask 및 FastAPI와 모두 호환되므로 일반 테스트 구조에 pytest를 사용하는 것이 좋습니다.

특히 FastAPI의 경우 TestClient는 HTTP 요청을 모의하고 응답을 확인하는 데 유용한 도구입니다.

pip와 함께 httpx를 설치해야 합니다.

pip install flask

로그인 후 복사

다음은 FastAPI 엔드포인트를 테스트하는 예입니다.

from flask import Flask, jsonify, request

app = Flask(__name__)

tasks = [
    {"id": 1, "task": "Learn Flask", "done": False},
    {"id": 2, "task": "Build API", "done": False}
]

@app.route('/tasks', methods=['GET'])
def get_tasks():
    return jsonify({"tasks": tasks})

@app.route('/tasks', methods=['POST'])
def create_task():
    new_task = {
        "id": len(tasks) + 1,
        "task": request.json["task"],
        "done": False
    }
    tasks.append(new_task)
    return jsonify(new_task), 201

@app.route('/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
    task = next((task for task in tasks if task["id"] == task_id), None)
    if task:
        return jsonify(task)
    return jsonify({"message": "Task not found"}), 404

@app.route('/tasks/<int:task_id>', methods=['PUT'])
def update_task(task_id):
    task = next((task for task in tasks if task["id"] == task_id), None)
    if task:
        task.update(request.json)
        return jsonify(task)
    return jsonify({"message": "Task not found"}), 404

@app.route('/tasks/<int:task_id>', methods=['DELETE'])
def delete_task(task_id):
    task = next((task for task in tasks if task["id"] == task_id), None)
    if task:
        tasks.remove(task)
        return jsonify({"message": "Task deleted"})
    return jsonify({"message": "Task not found"}), 404

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

로그인 후 복사

두 프레임워크 모두 테스트가 간단하며 특히 API가 발전함에 따라 API가 예상대로 작동하는지 확인할 수 있습니다.