From 1eb1a078b227aeba3fead6f3af7aac6679a41a03 Mon Sep 17 00:00:00 2001 From: zds <49744633+zds-s@users.noreply.github.com> Date: Mon, 21 Oct 2024 16:13:34 +0800 Subject: [PATCH] fixed doc v3 --- docs/zh/backend/base/event-handler.md | 3 --- docs/zh/backend/base/lifecycle.md | 2 +- docs/zh/backend/base/router.md | 6 +++--- docs/zh/backend/base/structure.md | 2 +- docs/zh/front/base/concept.md | 2 +- docs/zh/front/base/icon.md | 2 +- 6 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/zh/backend/base/event-handler.md b/docs/zh/backend/base/event-handler.md index c36a06f..15c818c 100644 --- a/docs/zh/backend/base/event-handler.md +++ b/docs/zh/backend/base/event-handler.md @@ -5,9 +5,6 @@ MineAdmin 的事件是基于 [hyperf/event](https://github.com/hyperf/event),要 ## 默认自带的监听者 -在 MineAdmin `>= 3.0` 版本中，我们准备了几个常用的事件处理。具体请查看项目 `config/autoload/listeners.php` 文件 - - | 监听者 | 作用 | 是否自带 | |---------------------------------|---------------------------------------------------------|------| | ErrorExceptionHandler | 当发生错误时，如果当前的错误报告级别与给定的错误级别匹配，就会抛出一个ErrorException异常 | √ | diff --git a/docs/zh/backend/base/lifecycle.md b/docs/zh/backend/base/lifecycle.md index b5d5533..05f18c4 100644 --- a/docs/zh/backend/base/lifecycle.md +++ b/docs/zh/backend/base/lifecycle.md @@ -22,7 +22,7 @@ MineAdmin 是构建运行在 [PHP](https://php.net) + ([Swoole](https://swoole.c ::: tip -自 `MineAdmin >= 3.0` 版本起，我们默认提供的应用程序认证机制都是由两个 token 来实现交互刷新鉴权的 +默认提供的应用程序认证机制都是由两个 token 来实现交互刷新鉴权的 也就是 `AccessToken` 以及 `RefreshToken` 而关于 Jwt 的生成和鉴权则统一由 MineAdmin 接入 [lcobucci/jwt](https://github.com/lcobucci/jwt) 组件而实现的 diff --git a/docs/zh/backend/base/router.md b/docs/zh/backend/base/router.md index 596edb8..a1764f7 100644 --- a/docs/zh/backend/base/router.md +++ b/docs/zh/backend/base/router.md @@ -1,7 +1,7 @@ # 路由与API文档 -自 `MineAdmin 3.0` 我们内置为所有接口接入了 [Swagger](https://swagger.io) 文档, -在本地开发时，访问 `localhost:9502/swagger` 即可访问现有的 API文档 +内置所有接口接入了 [Swagger](https://swagger.io) 文档, +在本地开发时，访问 `localhost:9503/swagger` 即可访问现有的 API文档 ::: tip @@ -38,7 +38,7 @@ ### HTTP 响应结构体 -在 `3.0` 版本中。我们推荐并遵循的是全局的响应对象为 `\App\Http\Common\Result`，也就是意味着 +推荐并遵循的是全局的响应对象为 `\App\Http\Common\Result`，也就是 在你的接口开发中，为了方便后续的`迭代升级`以及遵循统一的规范。你应该返回 `\App\Http\Common\Result` 实例。而不是自己拼接响应参数 同时我们也提供了 `App\Http\Common\Controller\AbstractController` 方便在日常开发中能够快速返回 `Result` 实例 diff --git a/docs/zh/backend/base/structure.md b/docs/zh/backend/base/structure.md index bfec936..e391c50 100644 --- a/docs/zh/backend/base/structure.md +++ b/docs/zh/backend/base/structure.md @@ -2,7 +2,7 @@ 默认的 MineAdmin 应用程序结构旨在为大型和小型应用程序提供一个良好的起点。但是你可以自由地组织你的应用程序 -在 `>=3.0` 版本中我们参考了 [laravel](https://laravel.com/) 的目录结构。如果你有接触过那么对你来说将会异常简单 +我们参考了 [laravel](https://laravel.com/) 的目录结构。如果你有接触过那么对你来说将会异常简单 ## 根目录 diff --git a/docs/zh/front/base/concept.md b/docs/zh/front/base/concept.md index e365ef8..595776d 100644 --- a/docs/zh/front/base/concept.md +++ b/docs/zh/front/base/concept.md @@ -1,6 +1,6 @@ # 基础概念 -最新的 `3.0` 版本，整个项目进行了重构，现在我们将会介绍一些基础概念，以便于你更好的理解整个文档，请务必仔先阅读这一部分。 +整个项目进行了重构，现在我们将会介绍一些基础概念，以便于你更好的理解整个文档，请务必仔先阅读这一部分。 ::: tip 以下所讲全部针对源码根目录下的 `./web` 里的结构 diff --git a/docs/zh/front/base/icon.md b/docs/zh/front/base/icon.md index 44cf040..06f5bec 100644 --- a/docs/zh/front/base/icon.md +++ b/docs/zh/front/base/icon.md @@ -1,7 +1,7 @@ # 图标 ## 解决方案 -3.0版本提供了两种使用图标的方案，系统内并未实际集成 `Element plus` 图标库，因为 `Iconify` 已包含。 +系统内并未实际集成 `Element plus` 图标库，因为 `Iconify` 已包含。 - Iconify 图标 （推荐） - 使用阿里巴巴图标库