Skip to content

Commit

Permalink
fixed doc v3
Browse files Browse the repository at this point in the history
  • Loading branch information
zds-s committed Oct 21, 2024
1 parent 8356528 commit 1eb1a07
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 10 deletions.
3 changes: 0 additions & 3 deletions docs/zh/backend/base/event-handler.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ MineAdmin 的事件是基于 [hyperf/event](https://github.com/hyperf/event),要

## 默认自带的监听者

在 MineAdmin `>= 3.0` 版本中,我们准备了几个常用的事件处理。具体请查看项目 `config/autoload/listeners.php` 文件


| 监听者 | 作用 | 是否自带 |
|---------------------------------|---------------------------------------------------------|------|
| ErrorExceptionHandler | 当发生错误时,如果当前的错误报告级别与给定的错误级别匹配,就会抛出一个ErrorException异常 ||
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/backend/base/lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) 组件而实现的
Expand Down
6 changes: 3 additions & 3 deletions docs/zh/backend/base/router.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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` 实例

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/backend/base/structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

默认的 MineAdmin 应用程序结构旨在为大型和小型应用程序提供一个良好的起点。但是你可以自由地组织你的应用程序

`>=3.0` 版本中我们参考了 [laravel](https://laravel.com/) 的目录结构。如果你有接触过那么对你来说将会异常简单
我们参考了 [laravel](https://laravel.com/) 的目录结构。如果你有接触过那么对你来说将会异常简单

## 根目录

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/front/base/concept.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 基础概念

最新的 `3.0` 版本,整个项目进行了重构,现在我们将会介绍一些基础概念,以便于你更好的理解整个文档,请务必仔先阅读这一部分。
整个项目进行了重构,现在我们将会介绍一些基础概念,以便于你更好的理解整个文档,请务必仔先阅读这一部分。

::: tip
以下所讲全部针对源码根目录下的 `./web` 里的结构
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/front/base/icon.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 图标

## 解决方案
3.0版本提供了两种使用图标的方案,系统内并未实际集成 `Element plus` 图标库,因为 `Iconify` 已包含。
系统内并未实际集成 `Element plus` 图标库,因为 `Iconify` 已包含。

- Iconify 图标 (推荐)
- 使用阿里巴巴图标库
Expand Down

0 comments on commit 1eb1a07

Please sign in to comment.