Flask-JWT-Extended安装与使用指南

Flask-JWT-Extended安装与使用指南

flask-jwt-extended An open source Flask extension that provides JWT support (with batteries included)!项目地址:https://gitcode.com/gh_mirrors/fl/flask-jwt-extended

一、项目目录结构及介绍

Flask-JWT-Extended是一个为Flask应用提供JSON Web Tokens（JWT）支持的开源扩展。以下是一个基本的目录结构示例，以及其中关键组件的简介：

• src/: 扩展的主要源代码存放处。
  • jwt.py: 包含核心JWT处理逻辑。
  • exceptions.py: 定义了该扩展特有的异常类型。
• examples/: 提供一些简单的示例应用，帮助快速上手。
• docs/: 文档目录，包含了详细的使用说明和配置指导。
• setup.py: 用于安装该扩展的Python脚本。
• tests/: 单元测试和集成测试代码。

二、项目的启动文件介绍

在使用Flask-JWT-Extended时，你的应用中并不会直接有一个“启动文件”是属于这个扩展的。但是，通常你会在你的Flask应用的主文件（如app.py或main.py）中集成此扩展。下面是如何初始化Flask-JWT-Extended的一个简要示例：

from flask import Flask
from flask_jwt_extended import JWTManager

app = Flask(__name__)
app.config['JWT_SECRET_KEY'] = 'your-secret-key' # 必须设置的密钥

# 初始化JWT管理器
jwt = JWTManager(app)

这段代码会在你的Flask应用中激活JWT功能，并设定一个加密的秘钥，这是JWT安全认证的基础。

三、项目的配置文件介绍

虽然Flask-JWT-Extended并没有严格要求使用特定的配置文件格式，但在实践中，这些配置常被添加到Flask应用的配置对象中。配置项应该被设置在你的Flask应用配置中，如上述示例所示。以下是一些关键的配置选项：

• JWT_SECRET_KEY: 必需，用于签名JWT的密钥。
• JWT_TOKEN_LOCATION: 指定JWT可以在哪里被查找，默认可以是headers或者cookies等。
• JWT_ACCESS_TOKEN_EXPIRES: 控制访问令牌的有效期，默认为30分钟。
• JWT_REFRESH_TOKEN_EXPIRES: 控制刷新令牌的有效期，如果有启用的话。
• 更多配置项可参考其官方文档。

这些配置应放在你的Flask应用配置里，例如：

app.config.update(
    JWT_SECRET_KEY='change_me_in_production',
    JWT_ACCESS_TOKEN_EXPIRES=timedelta(hours=1),
)

通过这种方式，你可以灵活地定制JWT的行为以适应不同的安全需求和应用场景。

flask-jwt-extended An open source Flask extension that provides JWT support (with batteries included)!项目地址:https://gitcode.com/gh_mirrors/fl/flask-jwt-extended