使用 Python 構建一個簡單的 RESTful API

nisan發表於2024-07-26
PythonRESTAPI

使用 Python 構建一個簡單的 RESTful API

1. 簡介

本文件旨在引導你使用 Python 構建一個簡單的 RESTful API。我們將使用 Flask 框架，因為它輕量級且易於使用。我們將建立一個 API，它可以返回一個隨機數和一個簡單的“Hello World”訊息。

2. 安裝 Flask

首先，確保你已經安裝了 Python。然後，使用 pip 安裝 Flask：

pip install Flask

3. 建立 API 檔案

建立一個名為 api.py 的檔案，並新增以下程式碼：

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/')
def hello():
    return jsonify({'message': 'Hello World!'})

@app.route('/random')
def random_number():
    import random
    return jsonify({'number': random.randint(1, 100)})

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

4. 程式碼解釋

  • from flask import Flask, jsonify: 匯入 Flask 和 jsonify 模組。
  • app = Flask(__name__): 建立一個 Flask 應用例項。
  • @app.route('/'): 定義一個路由，處理根路徑的請求。
  • def hello(): 定義一個函式，返回一個包含訊息的 JSON 物件。
  • @app.route('/random'): 定義另一個路由，處理 /random 路徑的請求。
  • def random_number(): 定義一個函式，生成一個隨機數並返回包含該數字的 JSON 物件。
  • if __name__ == '__main__':: 確保程式碼只在直接執行檔案時執行。
  • app.run(debug=True): 啟動 Flask 應用，並開啟除錯模式。

5. 執行 API

在命令列中執行以下命令：

python api.py

現在你就可以訪問 API 了。

  • 訪問 http://127.0.0.1:5000/ 會返回一個包含 "Hello World!" 訊息的 JSON 物件。
  • 訪問 http://127.0.0.1:5000/random 會返回一個包含隨機數的 JSON 物件。

6. 結論

在本文件中，你學習瞭如何使用 Python 和 Flask 構建一個簡單的 RESTful API。你可以根據自己的需求擴充套件這個 API，新增更多的路由和功能。

注意：

  • 為了安全起見，在生產環境中不要使用 debug=True。
  • 使用其他工具（如 Postman）可以方便地測試 API 請求。
  • 你可以參考 Flask 文件 https://flask.palletsprojects.com/en/2.0.x/ 瞭解更多資訊。

相關文章