From 53ea2a4226fb2663f91b87170b4a591c0b467b2e Mon Sep 17 00:00:00 2001 From: longgui-penglei Date: Wed, 20 Apr 2022 10:03:33 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20=20=E6=9B=B4?= =?UTF-8?q?=E6=96=B0=E5=89=8D=E7=AB=AF=E7=95=8C=E9=9D=A2=E8=AF=B4=E6=98=8E?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...15\347\253\257\347\225\214\351\235\242.md" | 21 ++++++++++++------- .../index.md" | 16 -------------- ...65\351\235\242\347\261\273\345\236\213.md" | 12 ----------- 3 files changed, 14 insertions(+), 35 deletions(-) rename "docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242/\351\205\215\347\275\256\345\210\206\346\236\220.md" => "docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242.md" (92%) delete mode 100644 "docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242/index.md" delete mode 100644 "docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242/\351\241\265\351\235\242\347\261\273\345\236\213.md" diff --git "a/docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242/\351\205\215\347\275\256\345\210\206\346\236\220.md" "b/docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242.md" similarity index 92% rename from "docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242/\351\205\215\347\275\256\345\210\206\346\236\220.md" rename to "docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242.md" index b25ec33ae..72ff808f6 100644 --- "a/docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242/\351\205\215\347\275\256\345\210\206\346\236\220.md" +++ "b/docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242.md" @@ -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的路由 ``` { @@ -34,7 +41,7 @@ 4. page -- 字符串或数组, 主页面单一为字符串, 主页面多个为数组 ``` -- 类型 2: 有子路由的路由 +- 类型 2: 有Children的路由 ``` { @@ -61,7 +68,7 @@ 拥有Child的路由, 在每一级的父级路由上都不应再存在page字段说明, 否则将会忽略 ``` -### **Pages(页面配置)** +#### **Pages(页面配置)** 该配置内容为一个数组列表, 包含前端所必需展示的页面中的必要配置选项。下面我们一起来了解一下: @@ -239,7 +246,7 @@ ActionType操作类型 [可扩展] ``` -### **读取步骤** +#### **读取步骤** 通过上述配置信息的了解, 相信正在阅读文档的你已经对我们的工作有了一定的了解。接下来, 将带领你进一步再了解一下从 OpenAPI 的读取到前端页面的生成过程。 diff --git "a/docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242/index.md" "b/docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242/index.md" deleted file mode 100644 index 7d4fe760f..000000000 --- "a/docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242/index.md" +++ /dev/null @@ -1,16 +0,0 @@ -# 概述 - -### **目标** - -> 旨在通过 OpenAPI 配置描述, 进一步在前端进行读取解析的方式, 直接生成前端项目页面。 - -根据上述的目标说明, 该文档也将从 OpenAPI 接口返回的 JSON 数据入手, 一步步分析每一项的配置对应到页面中的内容。 - -### **目录** - -- 页面生成 -- 页面类型 - -### **说明** - -前端界面说明文档将会持续更新... diff --git "a/docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242/\351\241\265\351\235\242\347\261\273\345\236\213.md" "b/docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242/\351\241\265\351\235\242\347\261\273\345\236\213.md" deleted file mode 100644 index 079fe954b..000000000 --- "a/docs/ \345\274\200\345\217\221\350\200\205\346\214\207\345\215\227/ \346\217\222\344\273\266\346\214\207\345\215\227/\345\211\215\347\253\257\347\225\214\351\235\242/\351\241\265\351\235\242\347\261\273\345\236\213.md" +++ /dev/null @@ -1,12 +0,0 @@ -# 页面类型 - -### **初识页面** - -1. 表格型页面 （table） -1. 表单型页面 （form） -1. 描述型页面 （description） -1. 树状型页面 （tree） -1. 切换型页面 （tabs） -1. 列表型页面 （list） -1. 卡片型页面 （cards） -1. 网格型页面 （grid）