Python寫一個簡單的api接口的實現

更新時間：2023年02月14日 09:19:22 作者：小創(chuàng)果

本文主要介紹了Python寫一個簡單的api接口的實現，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

python框架有很多，例如：Flask，Django，FastAPI 等。本文將使用 Flask 來編寫 API 接口。

安裝Flask

首先，您需要安裝 Flask：

pip install flask

寫主程序

接下來，我們可以創(chuàng)建一個名為 app.py 的文件，在其中編寫 Flask 應用程序代碼：

from flask import Flask, request

app = Flask(__name__)

@app.route('/api', methods=['GET'])
def api():
? ? name = request.args.get('name')
? ? if name:
? ? ? ? return "Hello, " + name
? ? else:
? ? ? ? return "Hello, World!"

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

運行代碼

python app.py

在瀏覽器中訪問 http://localhost:5000/api，應該會返回 “Hello, World!”。
如果向該 URL 添加參數，例如 http://localhost:5000/api?name=YourName，則會返回 “Hello, YourName”。

我們還可以給它添加一個簡單的token驗證

以下代碼來給 API 接口添加一個簡單的 token 驗證：

from flask import Flask, request

app = Flask(__name__)

@app.route('/api', methods=['GET'])
def api():
? ? token = request.args.get('token')
? ? if token != 'secret_token':
? ? ? ? return "Invalid token", 401
? ? name = request.args.get('name')
? ? if name:
? ? ? ? return "Hello, " + name
? ? else:
? ? ? ? return "Hello, World!"

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

在上面的代碼中，我們添加了一個 token 參數，并在該參數不為 secret_token 時返回一個 “Invalid token” 的錯誤響應（HTTP 狀態(tài)代碼 401）。
在實際生產環(huán)境中，應該使用更強大的身份驗證方法，而不是僅僅使用簡單的 token，但在本例中可以作為一個簡單的示例。
在生產環(huán)境中，您應該使用更復雜的身份驗證方法，例如：OAuth2，JWT 等。

在使用 Flask 的情況下，您可以使用第三方庫，例如 Flask-OAuthlib 或 Flask-JWT-Extended 來實現身份驗證。

下面是使用 Flask-JWT-Extended 實現身份驗證的示例代碼：

from flask import Flask, request
from flask_jwt_extended import (
? ? JWTManager, jwt_required, create_access_token,
? ? get_jwt_identity
)

app = Flask(__name__)

app.config['JWT_SECRET_KEY'] = 'secret-key'

jwt = JWTManager(app)

@app.route('/login', methods=['POST'])
def login():
? ? username = request.json.get('username', None)
? ? password = request.json.get('password', None)

? ? if username != 'test' or password != 'test':
? ? ? ? return {'message': 'Bad username or password'}, 401

? ? # identity is a simple string, like a username
? ? access_token = create_access_token(identity=username)
? ? return {'access_token': access_token}, 200

@app.route('/api', methods=['GET'])
@jwt_required
def api():
? ? current_user = get_jwt_identity()
? ? return "Hello, " + current_user

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

在上面的代碼中，我們定義了兩個路由：/login 和 /api。在 /login 中，我們檢查用戶名和密碼，如果正確，則創(chuàng)建一個 JWT 訪問令牌并將其返回給用戶。在 /api 中，我們使用 jwt_required 裝飾器來確保該 API 只能被擁有 JWT 令牌的用戶訪問。

在實際生產環(huán)境中，應該使用更復雜的身份驗證方法，例如：OAuth2，JWT 等。另外，還需要仔細考慮 JWT 秘密密鑰的安全性，以防止任何惡意用戶恢復或篡改 JWT 令牌。

為了確保身份驗證過程的安全性，還應該在客戶端使用 HTTPS 安全套接字層 (SSL/TLS) 連接到 API 接口，以防止數據在網絡中被竊取。

請注意，這僅是一個簡單的 JWT 身份驗證示例，在生產環(huán)境中，可能需要更復雜的驗證方法。因此，請確保在使用 JWT 或任何其他身份驗證方法之前，完全了解其安全性，以確保你的 API 接口不會受到攻擊。

到此這篇關于Python寫一個簡單的api接口的實現的文章就介紹到這了,更多相關Python api接口內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: