Przeglądaj źródła

web接口 主页说明

zhangweixin 4 lat temu
rodzic
commit
7a8bb346ef

+ 4 - 0
docs/dev/lib/coding/README.md

@@ -1,3 +1,7 @@
 #### 实体类结构规范
 #### 控制类 、service 规范
 #### 接口使用方式、调用,函数调用,自定义函数使用
+
+
+
+标准化 实体类、接口类 ,减少开发工作量,以及开发代码量

+ 5 - 1
docs/dev/lib/index.js

@@ -1,6 +1,10 @@
 const content = [
     {
-        title: "web接口支持规范",
+        title: "系统架构介绍",
+        path: "/dev/lib/coding/"
+    },
+    {
+        title: "web接口",
         path: "/dev/lib/web/",
         children: [
             ["/dev/lib/web/create", "创建"],

+ 40 - 4
docs/dev/lib/web/README.md

@@ -1,4 +1,40 @@
-#### swagger 为什么使用
-#### 标准接口(标准通用增删改查,请求体结构、应答结构、web端所有操作符使用)
-#### 定义接口(组合报表)
-#### 属性名 值的说明  属性名不区分大小写
+# web 接口
+## swagger 接口文档
+![接口文档 swagger](./img/web-swager_001.jpg)
+ 
+* 为保持代码与文档一致,接口说明使用swagger注解写在代码中。controller类及相关对外接口,实体类及属性要编写对应的swagger注解
+* swagger可以直接使用提供的接口页面测试。不需安装使用postman ,接口及相关参数在页面上都有明确说明。
+* 通过注解自动生成文档,节省编写文档时间
+![接口文档 swagger](./img/web-swager_004.jpg)
+
+![接口文档 swagger](./img/web-swager_005.jpg)
+
+点击 try it out 填写相应的参数
+
+![接口文档 swagger](./img/web-swager_006.jpg)
+点击 Execute 直接即可进行接口测试
+
+## 标准接口
+* 标准通用接口增删改查统计
+![接口文档 swagger](./img/web-swager_003.jpg)
+* 统一的请求体结构,应答结构
+* web端操作符的使用
+* 请求体重属性名不区分大小写,应答题返回标准的驼峰命名
+* 支持的值类型:int、float、double、boolean、char、date
+
+
+
+### 接口定义
+* 以对象为主的对象接口 ,唯物主义思想模式定义接口,面向对象编程理念,对象都一致,有相同接口,有利于前段使用接口的标准化,结构化,模块化,提高代码复用性,节约开发测试维护成本;
+![接口文档 swagger](./img/web-swager_002.jpg)
+* 规范化开发
+* 查询条件灵活的多样的
+* 专为应用服务的后台,比如数据中心就是围绕着物理世界或中台的壳,面向应用友好,主要针对应用和APP的需求,解决物理世界或中台对应用适配的问题
+
+
+
+
+
+
+
+

+ 7 - 2
docs/dev/lib/web/filters.md

@@ -131,8 +131,13 @@
 |:--:|:--:|:--:|
 | 非 | not <br> ! | not 表达式 <br> !表达式 |
 | 与 |  && <br> and | 表达式1 && 表达式2 <br> 表达式1 and 表达式2 |
-| 或 | \|\| <br> or | 属性名> > 值 |
-| 多表达式 | > | 属性名> > 值 |
+| 或 | \|\| <br> or | 表达式1 \|\| 表达式2  <br> 表达式1 or 表达式2 |
+| 多表达式 | ; | 表达式1 ; 表达式2 ; 表大式3 ... |
+
+#### 非 
+* not 例如设备有贴码状态 0.完成贴码 1.待贴码 2.带换码 3.带撕码  codeType ,查询完成贴码、带换码和带撕码的设备。
+
+
 
 
 

BIN
docs/dev/lib/web/img/web-swager_001.jpg


BIN
docs/dev/lib/web/img/web-swager_002.jpg


BIN
docs/dev/lib/web/img/web-swager_003.jpg


BIN
docs/dev/lib/web/img/web-swager_004.jpg


BIN
docs/dev/lib/web/img/web-swager_005.jpg


BIN
docs/dev/lib/web/img/web-swager_006.jpg