python3使用Flask實(shí)現(xiàn)api數(shù)據(jù)接口的示例詳解
本文是用Python3和Flask實(shí)現(xiàn)API數(shù)據(jù)接口的教程，適合入門(mén)者。先介紹項(xiàng)目準(zhǔn)備，包括Flask框架特點(diǎn)及開(kāi)發(fā)環(huán)境要求；接著講Flask環(huán)境搭建，含安裝Flask和創(chuàng)建項(xiàng)目目錄；然后說(shuō)明如何創(chuàng)建基礎(chǔ)API接口、實(shí)現(xiàn)數(shù)據(jù)交互（返回JSON格式數(shù)據(jù)和獲取URL參數(shù)）；還涉及API接口的部署與測(cè)試，如關(guān)閉調(diào)試模式和用Postman測(cè)試。通過(guò)學(xué)習(xí)，讀者可掌握Flask開(kāi)發(fā)API接口的基本方法，后續(xù)會(huì)介紹更復(fù)雜功能。
前言
Python作為一門(mén)簡(jiǎn)潔、易讀、功能強(qiáng)大的編程語(yǔ)言，其基礎(chǔ)語(yǔ)法是入門(mén)學(xué)習(xí)的核心。掌握好基礎(chǔ)語(yǔ)法，能為后續(xù)的編程實(shí)踐打下堅(jiān)實(shí)的基礎(chǔ)。本文將全面講解Python3的基礎(chǔ)語(yǔ)法知識(shí)，適合編程初學(xué)者系統(tǒng)學(xué)習(xí)。Python以其簡(jiǎn)潔優(yōu)雅的語(yǔ)法和強(qiáng)大的通用性，成為當(dāng)今最受歡迎的編程語(yǔ)言。本專欄旨在系統(tǒng)性地帶你從零基礎(chǔ)入門(mén)到精通Python核心。無(wú)論你是零基礎(chǔ)小白還是希望進(jìn)階的專業(yè)開(kāi)發(fā)者，都將通過(guò)清晰的講解、豐富的實(shí)例和實(shí)戰(zhàn)項(xiàng)目，逐步掌握語(yǔ)法基礎(chǔ)、核心數(shù)據(jù)結(jié)構(gòu)、函數(shù)與模塊、面向?qū)ο缶幊獭⑽募幚?、主流?kù)應(yīng)用（如數(shù)據(jù)分析、Web開(kāi)發(fā)、自動(dòng)化）以及面向?qū)ο蟾呒?jí)特性，最終具備獨(dú)立開(kāi)發(fā)能力和解決復(fù)雜問(wèn)題的思維，高效應(yīng)對(duì)數(shù)據(jù)分析、人工智能、Web應(yīng)用、自動(dòng)化腳本等廣泛領(lǐng)域的實(shí)際需求。
在當(dāng)今的軟件開(kāi)發(fā)領(lǐng)域，API（應(yīng)用程序編程接口）扮演著至關(guān)重要的角色，它是不同應(yīng)用之間進(jìn)行數(shù)據(jù)交互的橋梁。Flask 作為一款輕量級(jí)的 Python Web 框架，憑借其簡(jiǎn)潔、靈活的特點(diǎn)，成為實(shí)現(xiàn) API 數(shù)據(jù)接口的熱門(mén)選擇。本教程將詳細(xì)介紹如何使用 Python3 和 Flask 來(lái)搭建一個(gè)基礎(chǔ)的 API 數(shù)據(jù)接口，適合剛?cè)腴T(mén)的開(kāi)發(fā)者學(xué)習(xí)。
一、項(xiàng)目準(zhǔn)備
（一）了解 Flask 框架
Flask 是一個(gè)使用 Python 編寫(xiě)的輕量級(jí) Web 應(yīng)用框架。它沒(méi)有默認(rèn)使用的數(shù)據(jù)庫(kù)、窗體驗(yàn)證工具等，但它保留了靈活擴(kuò)展的空間，開(kāi)發(fā)者可以根據(jù)自己的需求選擇合適的工具和庫(kù)。相比 Django 等重量級(jí)框架，F(xiàn)lask 更加輕便，對(duì)于小型項(xiàng)目和 API 接口開(kāi)發(fā)非常友好。
（二）確定開(kāi)發(fā)環(huán)境
本項(xiàng)目將使用 Python3 作為開(kāi)發(fā)語(yǔ)言，建議使用 Python 3.6 及以上版本，以確保能正常支持 Flask 的相關(guān)特性。同時(shí)，需要安裝以下工具：
- pip：Python 的包管理工具，用于安裝 Flask 等依賴庫(kù)。
- 代碼編輯器：如 PyCharm、VS Code 等，方便編寫(xiě)和管理代碼。
二、Flask 環(huán)境搭建
（一）安裝 Flask
打開(kāi)命令行終端，輸入以下命令安裝 Flask：
pip install flask
等待安裝完成后，可以通過(guò)以下命令驗(yàn)證 Flask 是否安裝成功：
flask --version
如果終端輸出了 Flask 的版本信息，則說(shuō)明安裝成功。
（二）創(chuàng)建項(xiàng)目目錄
為了使項(xiàng)目結(jié)構(gòu)清晰，我們創(chuàng)建一個(gè)專門(mén)的項(xiàng)目目錄。在命令行中執(zhí)行以下命令：
mkdir flask-api-demo cd flask-api-demo
這樣就創(chuàng)建了一個(gè)名為flask-api-demo的項(xiàng)目目錄，并進(jìn)入該目錄。
三、創(chuàng)建基礎(chǔ) API 接口
（一）編寫(xiě)第一個(gè) Flask 應(yīng)用
在項(xiàng)目目錄下創(chuàng)建一個(gè)名為app.py的文件，這是我們 API 接口的主程序文件。在文件中輸入以下代碼：
from flask import Flask
# 創(chuàng)建Flask應(yīng)用實(shí)例
app = Flask(__name__)
# 定義路由和視圖函數(shù)
@app.route('/')
def hello_world():
return 'Hello, World!'
# 啟動(dòng)應(yīng)用
if __name__ == '__main__':
app.run(debug=True)
代碼解釋：
from flask import Flask：導(dǎo)入 Flask 類。app = Flask(__name__)：創(chuàng)建 Flask 應(yīng)用實(shí)例，__name__參數(shù)表示當(dāng)前模塊的名稱，F(xiàn)lask 會(huì)根據(jù)這個(gè)參數(shù)來(lái)確定應(yīng)用的根目錄。@app.route('/')：這是一個(gè)裝飾器，用于將 URL 路徑/與下面的hello_world函數(shù)綁定，當(dāng)用戶訪問(wèn)該 URL 時(shí)，會(huì)執(zhí)行這個(gè)函數(shù)。def hello_world(): return 'Hello, World!'：視圖函數(shù)，當(dāng)被調(diào)用時(shí)返回Hello, World!字符串。if __name__ == '__main__': app.run(debug=True)：當(dāng)直接運(yùn)行該腳本時(shí)，啟動(dòng) Flask 開(kāi)發(fā)服務(wù)器，debug=True表示開(kāi)啟調(diào)試模式，在代碼修改后會(huì)自動(dòng)重啟服務(wù)器。
（二）運(yùn)行第一個(gè) API 接口
在命令行終端中，進(jìn)入項(xiàng)目目錄，執(zhí)行以下命令運(yùn)行app.py文件：
python app.py
此時(shí)，終端會(huì)輸出類似以下的信息：
* Serving Flask app 'app' (lazy loading)
* Environment: development
* Debug mode: on
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with stat
* Debugger is active!
* Debugger PIN: 123-456-789
這表示 Flask 開(kāi)發(fā)服務(wù)器已經(jīng)啟動(dòng)，我們可以通過(guò)瀏覽器訪問(wèn)http://127.0.0.1:5000/，此時(shí)頁(yè)面會(huì)顯示Hello, World!，說(shuō)明我們的第一個(gè) API 接口已經(jīng)成功創(chuàng)建并運(yùn)行。
瀏覽器API效果：
四、實(shí)現(xiàn)數(shù)據(jù)交互
（一）返回 JSON 格式數(shù)據(jù)
在 API 接口中，通常返回的數(shù)據(jù)格式是 JSON，因?yàn)?JSON 格式易于解析和處理，且在不同編程語(yǔ)言之間具有良好的兼容性。Flask 提供了jsonify函數(shù)來(lái)幫助我們返回 JSON 格式的數(shù)據(jù)。修改app.py文件中的代碼：
from flask import Flask, jsonify
app = Flask(__name__)
# 模擬數(shù)據(jù)
users = [
{'id': 1, 'name': 'xcLeigh', 'age': 25},
{'id': 2, 'name': 'PukeA', 'age': 30},
{'id': 3, 'name': 'ShiTou', 'age': 35}
]
@app.route('/users')
def get_users():
return jsonify({'users': users})
if __name__ == '__main__':
app.run(debug=True)
代碼解釋：
from flask import Flask, jsonify：導(dǎo)入jsonify函數(shù)。- 定義了一個(gè)
users列表，里面包含了一些模擬的用戶數(shù)據(jù)。 @app.route('/users')：將 URL 路徑/users與get_users函數(shù)綁定。def get_users(): return jsonify({'users': users})：jsonify函數(shù)會(huì)將字典數(shù)據(jù)轉(zhuǎn)換為 JSON 格式的響應(yīng)，并設(shè)置響應(yīng)頭的Content-Type為application/json。
運(yùn)行app.py文件，訪問(wèn)http://127.0.0.1:5000/users，可以看到返回的 JSON 格式數(shù)據(jù)：
{
"users": [
{
"age": 25,
"id": 1,
"name": "xcLeigh"
},
{
"age": 30,
"id": 2,
"name": "PukeA"
},
{
"age": 35,
"id": 3,
"name": "ShiTou"
}
]
}瀏覽器API效果：
（二）獲取 URL 參數(shù)
在實(shí)際開(kāi)發(fā)中，我們經(jīng)常需要從 URL 中獲取參數(shù)，以便根據(jù)參數(shù)返回不同的數(shù)據(jù)。Flask 可以通過(guò)在路由中定義參數(shù)來(lái)實(shí)現(xiàn)這一功能。修改app.py文件：
from flask import Flask, jsonify
app = Flask(__name__)
users = [
{'id': 1, 'name': 'xcLeigh', 'age': 25},
{'id': 2, 'name': 'PukeA', 'age': 30},
{'id': 3, 'name': 'ShiTou', 'age': 35}
]
@app.route('/user/<int:user_id>')
def get_user(user_id):
# 查找指定ID的用戶
user = next((u for u in users if u['id'] == user_id), None)
if user:
return jsonify(user)
else:
return jsonify({'error': 'User not found'}), 404
if __name__ == '__main__':
app.run(debug=True)
代碼解釋：
@app.route('/user/<int:user_id>')：路由中<int:user_id>表示一個(gè)整數(shù)類型的參數(shù)user_id，當(dāng)用戶訪問(wèn)/user/1時(shí)，user_id的值為 1。def get_user(user_id):：視圖函數(shù)接收user_id參數(shù)。- 使用生成器表達(dá)式
next((u for u in users if u['id'] == user_id), None)查找指定 ID 的用戶，如果找到則返回該用戶的 JSON 數(shù)據(jù)，否則返回錯(cuò)誤信息，并設(shè)置響應(yīng)狀態(tài)碼為 404（表示資源未找到）。
運(yùn)行應(yīng)用后，訪問(wèn)http://127.0.0.1:5000/user/1，會(huì)返回 ID 為 1 的用戶數(shù)據(jù)；訪問(wèn)http://127.0.0.1:5000/user/4，會(huì)返回錯(cuò)誤信息。
瀏覽器API效果：
正確查詢結(jié)果
錯(cuò)誤信息
五、API 接口的部署與測(cè)試
（一）關(guān)閉調(diào)試模式
在生產(chǎn)環(huán)境中，我們需要關(guān)閉調(diào)試模式，以提高安全性和性能。修改app.py文件中啟動(dòng)應(yīng)用的代碼：
if __name__ == '__main__': app.run(debug=False, host='0.0.0.0', port=8080)
debug=False：關(guān)閉調(diào)試模式。host='0.0.0.0'：表示允許其他計(jì)算機(jī)訪問(wèn)該 API 接口。port=8080：設(shè)置服務(wù)器端口為 8080。
（二）使用 Postman 測(cè)試 API 接口
Postman 是一款強(qiáng)大的 API 測(cè)試工具，可以方便地發(fā)送各種 HTTP 請(qǐng)求并查看響應(yīng)結(jié)果。
- 下載并安裝 Postman。
- 打開(kāi) Postman，選擇
GET請(qǐng)求方法。 - 在地址欄中輸入 API 接口的 URL，如
http://127.0.0.1:8080/users。 - 點(diǎn)擊
Send按鈕，即可看到返回的響應(yīng)數(shù)據(jù)。
通過(guò) Postman 可以測(cè)試我們創(chuàng)建的各個(gè) API 接口，確保其正常工作。
六、總結(jié)
本教程介紹了使用 Python3 和 Flask 實(shí)現(xiàn)基礎(chǔ) API 數(shù)據(jù)接口的步驟，包括 Flask 環(huán)境的搭建、創(chuàng)建簡(jiǎn)單的 API 接口、實(shí)現(xiàn)數(shù)據(jù)交互以及 API 接口的部署與測(cè)試。通過(guò)本教程的學(xué)習(xí)，你已經(jīng)掌握了 Flask 開(kāi)發(fā) API 接口的基本方法。在后續(xù)的教程中，我們將進(jìn)一步介紹如何實(shí)現(xiàn)更復(fù)雜的功能，如處理 POST 請(qǐng)求、使用數(shù)據(jù)庫(kù)存儲(chǔ)數(shù)據(jù)等。希望本教程對(duì)你有所幫助，祝你在 Flask API 開(kāi)發(fā)的道路上越走越遠(yuǎn)！
到此這篇關(guān)于python3使用Flask實(shí)現(xiàn)api數(shù)據(jù)接口的示例詳解的文章就介紹到這了,更多相關(guān)python Flask實(shí)現(xiàn)api數(shù)據(jù)接口內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了Python元組解密：不可變的數(shù)據(jù)之美，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-11-11
Django模板語(yǔ)法、請(qǐng)求與響應(yīng)的案例詳解
本文主要介紹了Django的模板語(yǔ)法、請(qǐng)求與響應(yīng),包括如何創(chuàng)建和渲染模板文件、傳參機(jī)制、靜態(tài)文件的引入以及如何處理GET和POST請(qǐng)求,通過(guò)綜合小案例,展示了如何使用Django實(shí)現(xiàn)一個(gè)簡(jiǎn)單的登錄頁(yè)面并根據(jù)用戶名密碼進(jìn)行驗(yàn)證,感興趣的朋友跟隨小編一起看看2025-01-01
這篇文章主要介紹了python中l(wèi)ambda()的用法,在python中有一個(gè)匿名函數(shù)lambda，匿名函數(shù)顧名思義就是指：是指一類無(wú)需定義標(biāo)識(shí)符（函數(shù)名）的函數(shù)或子程序,需要的朋友可以參考下2017-11-11
Python有三大神器，一個(gè)是裝飾器，一個(gè)是迭代器、生成器，最后一個(gè)就是今天文章的主角 -- 「上下文管理器」。上下文管理器在日常開(kāi)發(fā)中的作用是非常大的，可能有些人用到了也沒(méi)有意識(shí)到這一點(diǎn)2022-12-12
這篇文章主要介紹了基于Python正確讀取資源文件,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-09-09
這篇文章主要介紹了python代碼的幾種常見(jiàn)加密方式分享，文章圍繞主題展開(kāi)詳細(xì)的內(nèi)容介紹，具有一定的參考價(jià)值，需要的朋友可以參考一下2022-07-07
python實(shí)現(xiàn)凱撒密碼、凱撒加解密算法
這篇文章主要介紹了python語(yǔ)言編程實(shí)現(xiàn)凱撒密碼、凱撒加解密算法,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2020-06-06
Python單鏈表的簡(jiǎn)單實(shí)現(xiàn)方法
這篇文章主要介紹了Python單鏈表的簡(jiǎn)單實(shí)現(xiàn)方法,包括定義所需的字段及具體實(shí)現(xiàn)代碼的分析,需要的朋友可以參考下2014-09-09
基于Opencv圖像識(shí)別實(shí)現(xiàn)答題卡識(shí)別示例詳解
這篇文章主要為大家詳細(xì)介紹了基于OpenCV如何實(shí)現(xiàn)答題卡識(shí)別，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2021-12-12
這篇文章主要介紹了Python自省及反射原理實(shí)例詳解,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07