Flask-RESTful: Python을 사용하여 RESTful API 구축

Flask-RESTful: Python을 사용하여 RESTful API 구축

최신 인터넷 서비스의 등장으로 RESTful API는 통신 프로토콜의 표준이 되었습니다. 고품질 RESTful API를 개발하기 위해 Python에는 Flask-RESTful이라는 효율적인 프레임워크가 있습니다. 이 기사에서는 Flask-RESTful이 무엇인지, Python을 사용하여 RESTful API를 구축하는 방법을 소개합니다.

1부: RESTful API 이해
REST(Representational State Transfer)는 HTTP 프로토콜을 기반으로 하는 웹 서비스 아키텍처 스타일로, 클라이언트가 액세스를 요청하고 리소스를 얻을 수 있으며, 서버가 요청한 리소스를 반환할 수 있습니다. API(애플리케이션 프로그래밍 인터페이스)는 프로그램과 시스템 간의 통신 프로토콜로, 서로 다른 애플리케이션이 정의된 인터페이스를 통해 서로 통신하여 특정 작업을 완료할 수 있도록 합니다. RESTful API는 리소스(URI)와 동작(HTTP 메서드)의 두 부분으로 구성됩니다.

리소스는 내부 데이터를 표현하는 RESTful API의 핵심입니다. URI(Uniform Resource Identifier)는 각 리소스의 위치를 ​​지정하며, 각 리소스에는 고유한 URI가 있습니다. 반면에 동작은 리소스에 액세스하고 조작하는 방법을 지정합니다. RESTful API는 HTTP 메소드를 사용하여 이러한 작업을 정의합니다. 예를 들어 GET 메소드는 리소스 검색에 사용되고, POST 메소드는 리소스 생성에 사용되고, PUT 메소드는 리소스 업데이트에 사용되고, DELETE 메소드는 리소스 삭제에 사용됩니다.

2부: Flask-RESTful 소개
Flask-RESTful은 Flask의 확장 모듈이자 Python RESTful 프레임워크입니다. RESTful API를 구축하기 위한 단순화된 방법과 도구를 제공합니다. Flask-RESTful의 장점은 다음과 같습니다.

1. 사용하기 쉽습니다.
Flask-RESTful은 Flask 프레임워크를 기반으로 하는 경량 프레임워크입니다. 개발자가 반복적인 코드를 많이 작성하지 않고도 RESTful API를 신속하게 구축하는 데 도움이 되는 간단한 도구 세트를 제공합니다.

2. 신속한 개발
요청 매개변수 구문 분석 및 경로 생성과 같은 몇 가지 단순화된 방법 덕분에 API 개발 시간을 크게 줄일 수 있습니다.

3. 확장 및 사용자 정의 지원 제공
Flask-RESTful은 유연한 확장 및 사용자 정의 지점을 제공하며 개발자는 필요에 따라 기능을 확장할 수 있습니다.

4. 문서가 매우 상세합니다.
Flask-RESTful의 문서는 매우 상세하고 배우고 사용하기 쉽습니다.

3부: Flask-RESTful 사용 방법
다음으로 Flask-RESTful을 사용하여 RESTful API를 구축하는 방법을 소개하겠습니다. 영화 데이터를 관리하기 위한 간단한 API를 만들어 보겠습니다. 이 API를 사용하면 클라이언트가 다음 작업을 수행할 수 있습니다.

1. 영화의 세부 정보 가져오기
3. 영화 정보 업데이트
5. Flask-RESTful을 설치 및 구성하고 Python 가상 환경을 생성합니다. 다음 명령을 사용하여 Flask-RESTful을 설치합니다(pip가 설치되어 있는지 확인).

pip install flask-restful

다음으로 app.py 파일을 만듭니다. 이 파일은 필수 모듈과 라이브러리를 가져와야 합니다. 이 파일은 Flask 애플리케이션을 정의하고 구현합니다.

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

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

여기에서는 Flask 및 Flask-RESTful 라이브러리와 모듈을 소개합니다. 다음으로 더미 데이터를 정의해 보겠습니다.

movies = [
{ 'id': 1, 'title': 'The Shawshank Redemption', 'director': 'Frank Darabont', 'year_released': 1994},
{ 'id': 2, 'title': 'Forrest Gump', 'director': 'Robert Zemeckis', 'year_released': 1994},
{ 'id': 3, 'title': 'The Matrix', 'director': 'The Wachowski Brothers', 'year_released': 1999},
{ 'id': 4, 'title': 'Léon: The Professional', 'director': 'Luc Besson', 'year_released': 1994},
{ 'id': 5, 'title': 'The Dark Knight', 'director': 'Christopher Nolan', 'year_released': 2008},
{ 'id': 6, 'title': 'Interstellar', 'director': 'Christopher Nolan', 'year_released': 2014},
{ 'id': 7, 'title': 'Inception', 'director': 'Christopher Nolan', 'year_released': 2010},
{ 'id': 8, 'title': 'The Lord of the Rings: The Fellowship of the Ring', 'director': 'Peter Jackson', 'year_released': 2001},
{ 'id': 9, 'title': 'Gladiator', 'director': 'Ridley Scott', 'year_released': 2000},
{ 'id': 10, 'title': 'The Godfather', 'director': 'Francis Ford Coppola', 'year_released': 1972}
]

이제 5가지 HTTP 요청(GET, POST, PUT, DELETE)을 처리하기 위한 5가지 리소스를 생성해 보세요.

class MovieList(Resource):
    def get(self):
        return { 'movies': movies }

    def post(self):
        parser = reqparse.RequestParser()
        parser.add_argument('title', type=str, required=True, help='Title is required.')
        parser.add_argument('director', type=str, required=True, help='Director is required.')
        parser.add_argument('year_released', type=int, required=True, help='Year must be a number.')
        args = parser.parse_args()

        movie = {
        'id': len(movies) + 1,
        'title': args['title'],
        'director': args['director'],
        'year_released': args['year_released']
        }

        movies.append(movie)
        return movie, 201

class Movie(Resource):
    def get(self, movie_id):
        movie = next(filter(lambda x:x['id']==movie_id, movies), None)
        return {'movie': movie}, 200 if movie else 404

    def put(self, movie_id):
        parser = reqparse.RequestParser()
        parser.add_argument('title', type=str, required=True, help='Title is required.')
        parser.add_argument('director', type=str, required=True, help='Director is required.')
        parser.add_argument('year_released', type=int, required=True, help='Year must be a number.')
        args = parser.parse_args()

        movie = next(filter(lambda x:x['id']==movie_id, movies), None)
        if movie is None:
            movie = {'id': movie_id, 'title': args['title'], 'director': args['director'], 'year_released': args['year_released']}
            movies.append(movie)
        else:
            movie.update(args)
        return movie

    def delete(self, movie_id):
        global movies
        movies = list(filter(lambda x:x['id']!=movie_id, movies))
        return {'message': 'Movie deleted.'}, 200

이러한 리소스는 URL과 연결된 경로에 매핑됩니다.

api.add_resource(MovieList, '/movies')
api.add_resource(Movie, '/movies/<int:movie_id>')

이제 Flask 애플리케이션을 실행하고 로컬 호스트( http://127.0.0.1:5000/movies )를 확인하면 방금 생성한 API 목록을 볼 수 있습니다.

{
"movies": [
    {
      "director": "Frank Darabont", 
      "id": 1, 
      "title": "The Shawshank Redemption", 
      "year_released": 1994
    },
    ...
  ]
}

이제 다음을 사용하여 새 API 목록을 추가할 수 있습니다. POST 방식 영화.

import requests

url = 'http://localhost:5000/movies'
data = {"title": "The Green Mile", "director": "Frank Darabont", "year_released": "1999"}
res = requests.post(url, data=data)

완전한 요청과 응답은 다음과 같습니다.

<Response [201]>
{'id': 11, 'title': 'The Green Mile', 'director': 'Frank Darabont', 'year_released': 1999}

PUT 메서드를 사용하여 영화 정보를 업데이트할 수도 있습니다.

url = 'http://localhost:5000/movies/11'
data = {"title": "The Green Mile", "director": "Frank Darabont", "year_released": "1999"}
res = requests.put(url, data=data)

마지막으로 영화를 삭제해 보겠습니다.

url = 'http://localhost:5000/movies/11'
res = requests.delete(url)

우리는 쉽게 개발하고 유지 관리할 수 있도록 Flask-RESTful 프레임워크를 사용하여 간단한 RESTful API를 만들었습니다. RESTful API는 웹 애플리케이션 개발을 위한 필수 구성 요소로, 클라이언트가 리소스에 액세스하고 업데이트할 수 있도록 하며 URI 및 HTTP 메서드를 강조합니다. Flask-RESTful을 동시에 사용하면 팀 개발 속도를 높이고 코드를 단순화할 수 있습니다.

위 내용은 Flask-RESTful: Python을 사용하여 RESTful API 구축의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!