完善开发文档与调整初始化项目架构

This commit is contained in:
wojiaoyishang
2025-01-28 17:47:41 +08:00
parent da5917344e
commit 41bda82c60
13 changed files with 316 additions and 9 deletions
+27
View File
@@ -0,0 +1,27 @@
后端页面编写
======================
该章节将介绍如何在 Pear Admin Flask 中编写一个新后端页面,此章节将会以编写积分兑奖系统为例,编写一个兑换码管理的后台页面。
.. _项目初始化逻辑:
项目初始化逻辑
-----------------------
我们知道,一个简单的 Flask 项目是从 `app = Flask(__name__)` 开始的,而 Pear Admin Flask 的初始化的逻辑同理也是在此基础上,不过稍加复杂了一点。
下面这张图片将会揭示项目初始化的逻辑。(点击可查看大图)
|
.. image:: ../_static/Pear\ Admin\ Flask\ 启动流程图.png
:target: ../_static/Pear\ Admin\ Flask\ 启动流程图.png
:align: center
|
由此可以看出,我们想要添加自己的后端页面,可以在 “注册项目的视图函数”(蓝框) 的地方添加,当然,同样页面可以作为插件的方式接入以提高项目的拓展性。
下面将介绍如何在这两种方式下添加自己的后台页面。
+2 -1
View File
@@ -7,4 +7,5 @@
plugin
trick
frontend
frontend
backend
+5
View File
@@ -133,8 +133,13 @@
pass
def event_context(app: Flask): # Flask 初始化完成,等待第一个请求之前,等同于 with app.app_context():
# 此时数据库已经初始化完成,尝试读取
pass
.. note::
事件的时机调用可以参考 :ref:`项目初始化逻辑` 章节。
.. important::
注意不要直接在 `__init__.py` 的函数外直接写存在阻塞的代码,不然项目 Flask 将不能初始化完成。
+6 -1
View File
@@ -35,6 +35,11 @@
使用不同的数据库需要安装另外的库,比如 mysql 要安装 pymysql 库(不同平台可能名称不一样),请自行查询资料而后进行配置。
添加后台菜单
------------
在 Pear Admin Flask 中,菜单的管理归属于 “权限管理” ,这样做的原因是为了使不同用户可以使用不同的访问控制。所以需要修改菜单,需要在 “权限管理” 页面编辑即可。
权限效验
------------
@@ -186,7 +191,7 @@ Schema 序列化
详情查看 :ref:`JSON 响应正文生成模块` 章节。
发送
发送
-----------------------
程序提供了发送邮件的模块,前提是需要正确在 `applications/config.py` 中配置 SMTP 服务器。详情查看 ref:`邮件模块` 章节。