瀏覽代碼

add a document used to explain the return value of interface.

171870002 5 年之前
父節點
當前提交
cfc765394b
共有 1 個文件被更改,包括 96 次插入0 次删除
  1. 96 0
      data-structure接口返回值说明文档.md

+ 96 - 0
data-structure接口返回值说明文档.md

@@ -0,0 +1,96 @@
+## data-structure部分接口返回值说明文档
+
+## 1.冒泡排序
+
+### (1)符号说明
+
+​	1.颜色和意义
+
+​	bule: 未排好序,不在比较或交换状态; 当完全排好序之后,所有值的颜色也是bule
+
+​	green: 未排好序,在比较或交换状态
+
+​	orange: 已排好序
+
+​	2.状态及意义
+
+​	onCompare: 两个值正在比较当中
+
+​	onExchange: 两个值正在交换当中,显示的是交换后的值和颜色
+
+​	beforeCompare: 没有正在比较或正在交换的值,所有值要么处于已拍好序状态,要么处于没拍好序,但未比较且未交换状态。
+
+​	AllSorted: 所有值都拍好序了,所有的值的颜色都是bule
+
+​	注:
+
+​	这里说明一下为什么没有交换后的状态(afterCompare)。因为在同一趟比较和交换当中,前一组值比较和交换完成之后就直接进入	下一组值的比较和交换状态了,而交换后的状态仅仅在一趟比较和交换完全完成之后且下一趟比较和交换还未开始的时候,此时的状态	既是上一趟比较结束后的afterCompare状态,也是下一趟比较未开始前的beforeCompare状态,所以这里统一归为beforeCompare状	态。另外,新加了AllSorted状态,这个状态在排序过程中仅出现一次,也是排序的最后状态类型。
+
+### (2)接口返回值格式(实际返回值response类型,json格式为{message:"",    isSuccess:"",content:""},以下返回值只写了content部分)
+
+ 	
+
+{
+
+​		initial:
+
+​		[{value:  ,color:  },{value:  ,color:  },{value:  ,color:  },...]
+
+​		onSortingSates:
+
+​		[
+
+​			{
+
+​				type:
+
+​				content: [{value:  ,color:  },{value:  ,color:  },{value:  ,color:  },...]
+
+​			},
+
+​			{
+
+​				type:
+
+​				content: [{value:  ,color:  },{value:  ,color:  },{value:  ,color:  },...]
+
+​			},
+
+​			{
+
+​				type:
+
+​				content: [{value:  ,color:  },{value:  ,color:  },{value:  ,color:  },...]
+
+​			},
+
+​					...
+
+​		]
+
+​	}
+
+
+
+## 2.stack
+
+### (1)初始化栈的操作
+
+​	stack有三个操作:初始化栈(可以指定栈大小,也可以不指定,使用默认值。),push,pop。初始化栈的操作不需要请求后端,只需	要在前端实现即可。
+
+### (2)push pop接口返回值格式(同样只写了response的content部分)
+
+​	1.push返回值://若push成功,content为push后的内容;若push失败,message显示原因,content显示原来栈的内容
+
+​	{
+
+​		capacity: 
+
+​		content:[1,2,3,4,5,...]
+
+​	}
+
+
+
+  2.pop的返回值同push
+