FastAPI JWT 项目教程

FastAPI JWT 项目教程

1. 项目的目录结构及介绍

fastapi-jwt/
├── docs/
│   └── ...
├── fastapi_jwt/
│   ├── __init__.py
│   └── ...
├── tests/
│   └── ...
├── .gitignore
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── VERSION
├── pyproject.toml
├── setup.cfg
└── setup.py

目录结构介绍

• docs/: 存放项目的文档文件。
• fastapi_jwt/: 核心代码目录，包含项目的所有源代码。
• tests/: 存放项目的测试代码。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• CHANGELOG.md: 项目更新日志。
• CONTRIBUTING.md: 贡献指南，指导开发者如何为项目贡献代码。
• LICENSE: 项目的开源许可证。
• README.md: 项目的主文档，包含项目的介绍、安装、使用等信息。
• VERSION: 项目的版本号。
• pyproject.toml: Python 项目的配置文件，定义项目的构建系统和依赖。
• setup.cfg: 项目的配置文件，定义项目的元数据和安装选项。
• setup.py: Python 项目的安装脚本。

2. 项目的启动文件介绍

在 fastapi_jwt 目录中，主要的启动文件是 __init__.py。这个文件通常包含项目的初始化代码和核心功能模块的导入。

# fastapi_jwt/__init__.py

from .jwt_auth import JwtAccessBearer, JwtAuthorizationCredentials

__all__ = ["JwtAccessBearer", "JwtAuthorizationCredentials"]

启动文件介绍

• __init__.py: 这个文件是 Python 包的初始化文件，通常用于导入模块和定义包的公共接口。在这个项目中，它导入了 JwtAccessBearer 和 JwtAuthorizationCredentials 两个核心类，供外部使用。

3. 项目的配置文件介绍

pyproject.toml

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "fastapi-jwt"
version = "0.1.0"
description = "FastAPI native extension for easy and simple JWT auth"
authors = [
    { name="k4black", email="k4black@example.com" }
]
dependencies = [
    "fastapi",
    "authlib",
    "python-jose[cryptography]"
]

配置文件介绍

• pyproject.toml: 这个文件定义了项目的构建系统和项目的基本信息。它指定了项目的名称、版本、描述、作者和依赖项。

setup.cfg

[metadata]
name = fastapi-jwt
version = 0.1.0
description = FastAPI native extension for easy and simple JWT auth
author = k4black
author_email = k4black@example.com
license = MIT

[options]
packages = find:
install_requires =
    fastapi
    authlib
    python-jose[cryptography]

配置文件介绍

• setup.cfg: 这个文件是项目的配置文件，定义了项目的元数据和安装选项。它包含了项目的名称、版本、描述、作者、许可证和依赖项。

通过以上内容，您可以了解 fastapi-jwt 项目的目录结构、启动文件和配置文件的基本信息。