Flask와 Python을 사용하여 RESTful API를 만드는 방법

RESTful API는 현대 개발에 필수적이며 다양한 시스템이 효율적이고 확장 가능한 방식으로 통신할 수 있도록 해줍니다. Flask 프레임워크를 갖춘 Python은 API 생성에 대한 간단하고 강력한 접근 방식을 제공합니다. 이 가이드에서는 Flask를 사용하여 RESTful API를 생성하는 방법을 살펴보고 HTTP 클라이언트를 사용한 기본 사항부터 인증 및 사용까지 모든 것을 다룹니다.

RESTful API란 무엇입니까?

코드를 시작하기 전에 RESTful API가 무엇인지 이해하는 것이 중요합니다. API(응용 프로그래밍 인터페이스)는 하나의 소프트웨어가 다른 소프트웨어와 통신할 수 있도록 하는 일련의 규칙입니다. REST(Representational State Transfer) 스타일은 API가 따라야 하는 일련의 원칙을 정의합니다.

• 클라이언트-서버: 클라이언트(API를 소비하는 사람)와 서버(데이터를 제공하는 사람)를 분리합니다.
• 상태 비저장: 클라이언트의 각 요청에는 서버가 처리하는 데 필요한 모든 정보가 포함되어야 합니다.
• 캐시 가능: 성능 향상을 위해 API 응답을 캐시할 수 있습니다.
• 균일한 인터페이스: 클라이언트와 서버 간의 통신은 GET, POST, PUT 및 DELETE와 같은 HTTP 메서드를 사용하여 표준화된 방식으로 수행되어야 합니다.

Flask를 사용하여 RESTful API 만들기

이제 사용자 목록을 관리하는 간단한 API를 만들어 보겠습니다. API를 사용하면 사용자를 추가, 편집, 보기, 삭제할 수 있습니다.

1. 플라스크 설치

먼저 Flask가 설치되어 있는지 확인하세요. 그렇지 않은 경우 pip를 사용하여 설치할 수 있습니다:

pip install Flask

2. 프로젝트 구조

우리 프로젝트의 구조는 다음과 같습니다.

/api_flask
│
├── app.py
└── requirements.txt

3. 플라스크 구성

app.py 파일에서 필요한 라이브러리를 가져오고 Flask 애플리케이션을 구성하는 것으로 시작합니다.

from flask import Flask, jsonify, request

app = Flask(__name__)

# Dados simulados
users = [
    {'id': 1, 'name': 'Alice', 'email': 'alice@example.com'},
    {'id': 2, 'name': 'Bob', 'email': 'bob@example.com'}
]

4. 엔드포인트 생성

이제 사용자 보기, 추가, 업데이트 및 삭제를 위한 엔드포인트를 만들어 보겠습니다.

4.1. 사용자를 나열할 엔드포인트

GET 메소드를 사용하여 모든 사용자를 나열합니다.

@app.route('/users', methods=['GET'])
def get_users():
    return jsonify(users), 200

4.2. 특정 사용자를 확보하기 위한 엔드포인트

특정 사용자의 세부 정보를 가져오기 위해 사용자 ID와 함께 GET 메소드를 사용합니다.

@app.route('/users/<int:user_id>', methods=['GET'])
def get_user(user_id):
    user = next((user for user in users if user['id'] == user_id), None)
    if user:
        return jsonify(user), 200
    else:
        return jsonify({'message': 'User not found'}), 404

4.3. 새 사용자를 생성하기 위한 엔드포인트

새 사용자를 추가하려면 POST 방법을 사용합니다. 클라이언트는 JSON 형식으로 데이터를 보냅니다.

@app.route('/users', methods=['POST'])
def create_user():
    data = request.get_json()
    new_user = {
        'id': len(users) + 1,
        'name': data['name'],
        'email': data['email']
    }
    users.append(new_user)
    return jsonify(new_user), 201

4.4. 사용자 업데이트를 위한 엔드포인트

여기에서는 PUT 메소드를 사용하여 기존 사용자의 데이터를 업데이트합니다.

@app.route('/users/<int:user_id>', methods=['PUT'])
def update_user(user_id):
    data = request.get_json()
    user = next((user for user in users if user['id'] == user_id), None)
    if user:
        user['name'] = data['name']
        user['email'] = data['email']
        return jsonify(user), 200
    else:
        return jsonify({'message': 'User not found'}), 404

4.5. 사용자 삭제를 위한 엔드포인트

DELETE 메소드를 사용하여 사용자를 제거합니다.

@app.route('/users/<int:user_id>', methods=['DELETE'])
def delete_user(user_id):
    global users
    users = [user for user in users if user['id'] != user_id]
    return jsonify({'message': 'User deleted'}), 200

5. API 실행

이제 애플리케이션을 실행해 보세요.

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

app.py 파일을 실행하면 http://127.0.0.1:5000/users에서 API를 사용할 수 있습니다.

6. Flask를 이용한 인증

API에 보안 계층을 추가하려면 JWT(JSON 웹 토큰)을 사용할 수 있습니다. JWT를 사용하면 인증된 사용자만 특정 엔드포인트에 액세스할 수 있도록 보장할 수 있습니다.

6.1. Flask-JWT-확장 설치

필요한 확장 프로그램 설치:

pip install Flask-JWT-Extended

6.2. JWT 구성

JWT 인증을 포함하도록 app.py 파일을 업데이트하세요.

from flask_jwt_extended import JWTManager, create_access_token, jwt_required

app.config['JWT_SECRET_KEY'] = 'your-secret-key'  # Troque pela sua chave secreta
jwt = JWTManager(app)

# Login para obter o token
@app.route('/login', methods=['POST'])
def login():
    data = request.get_json()
    if data['username'] == 'admin' and data['password'] == 'admin':
        access_token = create_access_token(identity={'username': 'admin'})
        return jsonify(access_token=access_token), 200
    else:
        return jsonify({'message': 'Invalid credentials'}), 401

# Exemplo de endpoint protegido
@app.route('/protected', methods=['GET'])
@jwt_required()
def protected():
    return jsonify({'message': 'Access granted to protected endpoint'}), 200

이제 /protected 엔드포인트에 접근할 때 사용자 인증을 위해 요청 헤더에 JWT 토큰을 보내야 합니다.

7. HTTP 클라이언트로 API 사용

API를 사용하려면 Postman과 같은 도구나 Python의 요청과 같은 라이브러리를 사용할 수 있습니다.

요청을 사용하여 API를 사용하는 방법의 예:

import requests

# Consumindo o endpoint de listagem de usuários
response = requests.get('http://127.0.0.1:5000/users')
print(response.json())

결론

Flask를 사용하여 RESTful API를 만드는 것은 간단하고 유연합니다. Flask는 인증, 오류 처리 및 기타 보안 계층과 같은 기능을 포함하도록 확장할 수 있는 최소한의 프레임워크를 제공합니다. REST 원칙과 우수한 개발 사례를 따르면 Python으로 효율적이고 확장 가능한 API를 구축할 수 있습니다.

이제 Flask를 사용하여 자신만의 RESTful API를 구축하고 요구사항에 따라 맞춤설정할 수 있습니다.

위 내용은 Flask와 Python을 사용하여 RESTful API를 만드는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!