Skip to content

Commit

Permalink
docs: ✏️ 更新前端界面说明文档
Browse files Browse the repository at this point in the history
  • Loading branch information
longgui-penglei committed Apr 20, 2022
1 parent 80a2002 commit 53ea2a4
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 35 deletions.
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
# 配置分析
## 从OpenAPI到前端界面

### **初识接口**
### 目标

> 旨在通过 OpenAPI 配置描述, 进一步在前端进行读取解析的方式, 直接生成前端项目页面。
根据上述的目标说明, 该文档也将从 OpenAPI 接口返回的 JSON 数据入手, 一步步分析每一项的配置对应到页面中的内容。

### 配置分析

#### 初识接口
/api/v1/openapi.json

上述接口主要返回 components/info/pages/paths/routers/translation 等数据信息。当前文档主要分析
其中的 routers 以及 pages 内容, 也就是主要分析怎样通过这些信息在前端生成一个个页面的。

### **Routers(路由配置)**
#### **Routers(路由配置)**

> Router 的类型有两种
- 类型 1: 无子路由的路由
- 类型 1: 无Children的路由

```
{
Expand All @@ -34,7 +41,7 @@
4. page -- 字符串或数组, 主页面单一为字符串, 主页面多个为数组
```

- 类型 2: 有子路由的路由
- 类型 2: 有Children的路由

```
{
Expand All @@ -61,7 +68,7 @@
拥有Child的路由, 在每一级的父级路由上都不应再存在page字段说明, 否则将会忽略
```

### **Pages(页面配置)**
#### **Pages(页面配置)**

该配置内容为一个数组列表, 包含前端所必需展示的页面中的必要配置选项。下面我们一起来了解一下:

Expand Down Expand Up @@ -239,7 +246,7 @@ ActionType操作类型 [可扩展]
```

### **读取步骤**
#### **读取步骤**

通过上述配置信息的了解, 相信正在阅读文档的你已经对我们的工作有了一定的了解。接下来, 将带领你进一步再了解一下从 OpenAPI 的读取到前端页面的生成过程。

Expand Down
16 changes: 0 additions & 16 deletions docs/ 开发者指南/ 插件指南/前端界面/index.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/ 开发者指南/ 插件指南/前端界面/页面类型.md

This file was deleted.

0 comments on commit 53ea2a4

Please sign in to comment.