Flask-RESTful：使用Python建立RESTful API

Flask-RESTful：使用Python建立RESTful API

隨著現代網路服務的崛起，RESTful API已成為通訊協定的標準。為了開發高品質的RESTful API， Python有一個高效率的框架， Flask-RESTful。本文將介紹什麼是Flask-RESTful以及如何使用Python來建立RESTful API。

第一部分：了解RESTful API
REST（表述性狀態轉移）是基於HTTP協定的一種Web服務的架構風格，它允許客戶端請求存取和取得資源，並允許服務端返回請求的資源。 API（應用程式介面）則是程式和系統之間的通訊協議，它允許不同的應用程式透過定義的介面相互通信，從而實現完成特定的任務。 RESTful API由兩部分組成：資源（URI）和行為（HTTP方法）。

資源是RESTful API的核心，也就是對內部資料的表達。 URI（統一資源識別碼）指定了每個資源的位置，每個資源都有一個唯一的URI。另一方面，行為指定如何存取和操作資源。 RESTful API使用HTTP方法來定義這些操作，例如，GET方法用於檢索資源，POST方法用於建立資源，PUT方法用於更新資源，DELETE方法用於刪除資源。

第二部分：介紹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的文件非常詳細，容易學習和使用。

第三部分：如何使用Flask-RESTful
接下來，我們將介紹如何使用Flask-RESTful來建立RESTful API。我們將創建一個簡單的API，用於管理電影資料。這個API將允許客戶端進行以下操作：

1、列出所有電影
2、獲取一個電影的詳細資訊
3、新增電影
4、更新電影資訊
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個不同的資源來處理5個不同的HTTP請求：GET，POST，PUT，DELETE。

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
    },
    ...
  ]
}

現在，我們可以使用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)

我們創建了一個簡單的RESTful API，使用Flask-RESTful框架使其易於開發和維護。 RESTful API是開發網頁應用程式的必不可少的元件，它允許客戶端對資源進行存取和更新，並強調URI和HTTP方法。同時使用Flask-RESTful可以加快團隊的開發速度並簡化程式碼。

以上是Flask-RESTful：使用Python建立RESTful API的詳細內容。更多資訊請關注PHP中文網其他相關文章！