cowr_dict/src/main/webapp/doc/api.txt

68 lines
1.4 KiB
Plaintext
Raw Normal View History

2017-02-20 13:36:55 +08:00
index (
pageSize optional default 20,
pageNum optional default 1,
2017-02-28 10:34:17 +08:00
json optional,
proj optional,
sort optional
2017-02-20 13:36:55 +08:00
) {
2017-02-20 15:25:47 +08:00
special json: {
key: $ex //exists
key: $nex //not exists
key: $revalue //模糊查询,例:$re^te te开头的value
2017-02-28 10:34:17 +08:00
},
proj json: {
key1: 1,
key2:0
//必须全是1或者全是0id除外
},
sort: {
key1: 'desc',
key2: 'asc'
2017-02-20 15:25:47 +08:00
}
2017-02-20 13:36:55 +08:00
return dict list json
}
show (id required) {
return dict json
}
save (json required) {
return saved dict json with id
}
update (id required, json required) {
2017-02-20 13:42:00 +08:00
json {
2017-02-20 14:13:12 +08:00
$set: {k,v...},
$unset: [k1,k2...],
$rename: {k,newK...}
2017-02-20 13:42:00 +08:00
}
2017-02-20 13:36:55 +08:00
return {result : true or false}
}
delete (id required) {
return {result: true or false}
}
@Deprecated
2017-02-16 17:26:12 +08:00
dict (key-value pairs) {
return dict list json
2017-02-16 16:36:22 +08:00
}
dictList (int pageNum default 0, int pageSize default 20) {
return dict list json
}
2017-02-16 16:57:45 +08:00
addDict (String name required, key-value pairs) {
2017-02-16 17:16:21 +08:00
return dict json
2017-02-16 16:36:22 +08:00
}
updateDict (String id required, String action optional, String[] keys optional) {
if (actions === 'unset') {
删除指定id的dict的指定key
2017-02-16 17:16:21 +08:00
return {result: true or false}
2017-02-16 16:36:22 +08:00
} else {
覆盖指定id的dict的指定key的对应value
2017-02-16 17:16:21 +08:00
return {result: true or false}
2017-02-16 16:36:22 +08:00
}
}
deleteDict (String id required) {
2017-02-16 17:16:21 +08:00
return return {result: true or false}
2017-02-16 16:36:22 +08:00
}