diff --git a/open-api/content/content-category.md b/open-api/content/content-category.md index aa3d80a5..f4468de7 100644 --- a/open-api/content/content-category.md +++ b/open-api/content/content-category.md @@ -106,18 +106,33 @@ curl_close($ch); **接口** -`GET https://cloud.minapp.com/oserve/v1/content/:content_group_id/category/` +`GET https://cloud.minapp.com/oserve/v2.2/content/:content_group_id/category/` + +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **提交参数** - parent 内容分类父分类列表查询 - `https://cloud.minapp.com/oserve/v1/content/:content_group_id/category/?parent__isnull=true` + `https://cloud.minapp.com/oserve/v2.2/content/:content_group_id/category/?parent__isnull=true` - name 内容分类名称的等值查询 - `https://cloud.minapp.com/oserve/v1/content/:content_group_id/category/?name=category` + `https://cloud.minapp.com/oserve/v2.2/content/:content_group_id/category/?name=category` + +- return_total_count 指定是否在 meta 中返回 total_count + + `https://cloud.minapp.com/oserve/v2.2/content/:content_group_id/category/?return_total_count=0` +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/oserve/v2.2/content/:content_group_id/category/?limit=1&return_total_count=1 +``` **代码示例** @@ -129,7 +144,7 @@ curl_close($ch); curl -X GET \ -H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \ -H "Content-Type: application/json" \ -https://cloud.minapp.com/oserve/v1/content/1/category/ +https://cloud.minapp.com/oserve/v2.2/content/1/category/ ``` {% content "getContentCategoryListNode" %} @@ -138,7 +153,7 @@ https://cloud.minapp.com/oserve/v1/content/1/category/ var request = require("request"); var options = { method: 'GET', - url: 'https://cloud.minapp.com/oserve/v1/content/1/category/', + url: 'https://cloud.minapp.com/oserve/v2.2/content/1/category/', headers: { 'Content-Type': 'application/json', Authorization: 'Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4' } }; @@ -155,7 +170,7 @@ request(options, function (error, response, body) { ```php **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **提交参数** @@ -89,9 +93,21 @@ curl_close($ch); 例:查询内容库名称为 "内容库1" 的内容库 - `https://cloud.minapp.com/oserve/v1/content/?name=内容库1` + `https://cloud.minapp.com/oserve/v2.2/content/?name=内容库1` + +- return_total_count 指定是否在 meta 中返回 total_count + + 例:指定返回 total_count + + `https://cloud.minapp.com/oserve/v2.2/content/?return_total_count=1` +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 +请求示例: + +``` +https://cloud.minapp.com/oserve/v2.2/content/?limit=1&return_total_count=1 +``` **代码示例** @@ -103,7 +119,7 @@ curl_close($ch); curl -X GET \ -H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \ -H "Content-Type: application/json" \ -https://cloud.minapp.com/oserve/v1/content/ +https://cloud.minapp.com/oserve/v2.2/content/ ``` {% content "getContentGroupListNode" %} @@ -112,7 +128,7 @@ https://cloud.minapp.com/oserve/v1/content/ var request = require("request"); var options = { method: 'GET', - url: 'https://cloud.minapp.com/oserve/v1/content/', + url: 'https://cloud.minapp.com/oserve/v2.2/content/', headers: { 'Content-Type': 'application/json', Authorization: 'Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4' } }; @@ -128,7 +144,7 @@ request(options, function (error, response, body) { ```php **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **提交参数** 内容查询与[数据表接口](../data/record.md)查询保持一致 +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/oserve/v2.2/content/:content_group_id/text/?limit=1&return_total_count=1 +``` + **代码示例** {% tabs getRichTextEntryListCurlCurl="Curl", getRichTextEntryListCurlNode="Node", getRichTextEntryListPHP="PHP" %} @@ -126,7 +138,7 @@ curl_close($ch); curl -X GET \ -H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \ -H "Content-Type: application/json" \ -https://cloud.minapp.com/oserve/v1/content/1/text/ +https://cloud.minapp.com/oserve/v2.2/content/1/text/ ``` {% content "getRichTextEntryListCurlNode" %} @@ -135,7 +147,7 @@ https://cloud.minapp.com/oserve/v1/content/1/text/ var request = require("request"); var options = { method: 'GET', - url: 'https://cloud.minapp.com/oserve/v1/content/1/text/', + url: 'https://cloud.minapp.com/oserve/v2.2/content/1/text/', headers: { 'Content-Type': 'application/json', Authorization: 'Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4' } }; @@ -152,7 +164,7 @@ request(options, function (error, response, body) { ```php **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 + **参数说明** Content-Type: `application/json` @@ -20,6 +24,7 @@ Content-Type: `application/json` | order_by | String | N | 对资源进行字段排序 | | limit | Number | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 | | offset | Number | N | 设置返回资源的起始偏移值,默认为 0 | +| return_total_count | Number | N | 返回结果 meta 中是否返回 total_count,1 为返回,0 为不返回,默认不返回 | 例如需要查询价格为 10 元的物品时,我们应该这样构造查询语句: @@ -37,7 +42,7 @@ curl -X GET \ -H "Content-Type: application/json" \ -G \ --data-urlencode 'where={"price":"$eq":10}' \ -https://cloud.minapp.com/oserve/v1/table/1/record/ +https://cloud.minapp.com/oserve/v2.2/table/1/record/ ``` 该接口完整支持的查询操作符如下: @@ -78,6 +83,14 @@ https://cloud.minapp.com/oserve/v1/table/1/record/ } ``` +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/oserve/v2.2/table/:table_id/record/?limit=1&return_total_count=1 +``` + ## 排序返回查询数据 查询接口默认按**创建时间倒序**的顺序来返回数据列表,你也可以通过设置 `order_by` 参数来实现。 @@ -86,10 +99,10 @@ https://cloud.minapp.com/oserve/v1/table/1/record/ ``` # 顺序 -https://cloud.minapp.com/oserve/v1/table/:table_id/record/?order_by=created_at +https://cloud.minapp.com/oserve/v2.2/table/:table_id/record/?order_by=created_at # 倒序 -https://cloud.minapp.com/oserve/v1/table/:table_id/record/?order_by=-created_at +https://cloud.minapp.com/oserve/v2.2/table/:table_id/record/?order_by=-created_at ``` **代码示例** @@ -102,7 +115,7 @@ https://cloud.minapp.com/oserve/v1/table/:table_id/record/?order_by=-created_at var request = require('request'); var opt = { - uri: 'https://cloud.minapp.com/oserve/v1/table/3906/record/', // 3906 对应 :table_id + uri: 'https://cloud.minapp.com/oserve/v2.2/table/3906/record/', // 3906 对应 :table_id method: 'GET', headers: { Authorization: `Bearer ${token}`, @@ -114,6 +127,7 @@ var opt = { order_by: '-created_at', // 可选 offset: 0, // 可选 limit: 20, // 可选 + return_total_count: 0 // 可选,若不指定则默认不返回 total_count } } @@ -132,7 +146,7 @@ import requests table_id = '' -BASE_API = r'https://cloud.minapp.com/oserve/v1/table/%s/record/' % table_id +BASE_API = r'https://cloud.minapp.com/oserve/v2.2/table/%s/record/' % table_id TOKEN = '' HEADERS = { @@ -148,6 +162,7 @@ query_ = urllib.urlencode({ 'order_by': '-created_at', 'limit': 10, 'offset': 0, + 'return_total_count': 0 }) API = '?'.join((BASE_API, query_)) @@ -165,9 +180,10 @@ $condition = array( 'order_by' => '-created_at', 'where' => json_encode(['price' => ['$gt' => 'test search']]), 'limit' => '10', - 'offset' => '0' + 'offset' => '0', + 'return_total_count' => '0' ); -$url = "https://cloud.minapp.com/oserve/v1/table/{$table_id}/record/?"; +$url = "https://cloud.minapp.com/oserve/v2.2/table/{$table_id}/record/?"; $url .= http_build_query($condition); $ch = curl_init(); @@ -1325,10 +1341,14 @@ operation_result 包含的 Object 的参数说明: **接口** -`PUT https://cloud.minapp.com/oserve/v2.0/table/:table_id/record/` +`PUT https://cloud.minapp.com/oserve/v2.2/table/:table_id/record/` 其中 `:table_id` 是数据表的 ID。单次请求最多修改 1000 条数据,支持触发触发器。 +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回待更新对象总数,以协助不关心对象总数只关心数据更新结果的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回待更新对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 + **Query 参数说明** | 参数 | 类型 | 必填 | 说明 | @@ -1336,6 +1356,7 @@ operation_result 包含的 Object 的参数说明: | where | String | N | 查询语句,参数值应经过 JSON 编码为 JSONString 后,再经过 URL 编码 | | limit | Integer | Y | 设置单次请求可以更新最大数据条数,默认为 1000 | | offset | Integer | N | 设置更新的起始偏移值,默认为 0 | +| return_total_count | Integer | N | 返回结果中是否包含 total_count,1 为包含,0 为不包含,默认不包含 | **参数说明** @@ -1351,7 +1372,7 @@ Content-Type: `application/json` ```shell curl -X PUT \ - https://cloud.minapp.com/oserve/v2.0/table/70264/record/ \ + https://cloud.minapp.com/oserve/v2.2/table/70264/record/ \ -H 'Authorization: Bearer 35919068aa799eccdef19160e1da4bf21381d2a2' \ -H 'Content-Type: application/json' \ -d '{"name": "Sam"}' @@ -1364,7 +1385,7 @@ var request = require("request"); var options = { method: 'PUT', - url: 'https://cloud.minapp.com/oserve/v2.0/table/70264/record/', + url: 'https://cloud.minapp.com/oserve/v2.2/table/70264/record/', headers: { 'Content-Type': 'application/json', @@ -1385,7 +1406,7 @@ var req = request(options, function (error, response, body) { ```php **info** +> 该接口支持通过参数 return_total_count 指定是否返回待删除对象总数,以协助不关心对象总数只关心数据删除结果的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回待删除对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 + **Query 参数说明** | 参数 | 类型 | 必填 | 说明 | @@ -1488,6 +1513,7 @@ operation_result 包含的 Object 的参数说明: | where | String | N | 查询语句,参数值应经过 JSON 编码为 JSONString 后,再经过 URL 编码 | | limit | Integer | Y | 设置单次请求至多可以删除多少条数据,默认为 1000 | | offset | Integer | N | 设置删除的起始偏移值,默认为 0 | +| return_total_count | Integer | N | 返回结果中是否包含 total_count,1 为包含,0 为不包含,默认不包含 | **代码示例** @@ -1497,7 +1523,7 @@ operation_result 包含的 Object 的参数说明: ```shell curl -X DELETE \ - https://cloud.minapp.com/oserve/v2.0/table/70264/record/?where={"pretty": true} \ + https://cloud.minapp.com/oserve/v2.2/table/70264/record/?where={"pretty": true} \ -H 'Authorization: Bearer 35919068aa799eccdef19160e1da4bf21381d2a2' \ ``` @@ -1508,7 +1534,7 @@ var request = require("request"); var options = { method: 'DELETE', - url: 'https://cloud.minapp.com/oserve/v2.0/table/70264/record/', + url: 'https://cloud.minapp.com/oserve/v2.2/table/70264/record/', headers: { Authorization: 'Bearer 35919068aa799eccdef19160e1da4bf21381d2a2' @@ -1531,7 +1557,7 @@ var req = request(options, function (error, response, body) { ```php **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **参数说明** @@ -178,6 +182,15 @@ Content-Type: `application/json` | order_by | String | N | 排序(支持 `created_at` 进行排序)| | limit | Number | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 | | offset | Number | N | 设置返回资源的起始偏移值,默认为 0 | +| return_total_count | Number | N | 返回结果 meta 中是否返回 total_count,1 为返回,0 为不返回,默认不返回 | + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/oserve/v2.2/file-category/?limit=1&return_total_count=1 +``` **代码示例** @@ -191,7 +204,7 @@ curl -X GET \ -H "Content-Type: application/json" \ -G \ -d order_by=-created_at \ -https://cloud.minapp.com/oserve/v1/file-category/ +https://cloud.minapp.com/oserve/v2.2/file-category/ ``` {% content "getCategoryNode" %} @@ -200,7 +213,7 @@ https://cloud.minapp.com/oserve/v1/file-category/ var request = require('request'); var opt = { - uri: 'https://cloud.minapp.com/oserve/v1/file-category/', + uri: 'https://cloud.minapp.com/oserve/v2.2/file-category/', method: 'GET', headers: { Authorization: `Bearer ${token}` @@ -221,7 +234,7 @@ request(opt, function(err, res, body) { ```php **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **参数说明** @@ -103,6 +107,15 @@ Content-Type: `application/json` | order_by | String | Y | 排序(支持 `created_at` 进行排序)| | limit | Number | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 | | offset | Number | N | 设置返回资源的起始偏移值,默认为 0 | +| return_total_count | Number | N | 返回结果 meta 中是否返回 total_count,1 为返回,0 为不返回,默认不返回 | + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/oserve/v2.2/file/?limit=1&return_total_count=1 +``` **代码示例** @@ -117,7 +130,7 @@ curl -X GET \ -G \ -d order_by=-created_at \ -d category=5a1ba7b708443e7fc5f2fb18 \ -https://cloud.minapp.com/oserve/v1/file/ +https://cloud.minapp.com/oserve/v2.2/file/ ``` {% content "getFileListNode" %} @@ -126,7 +139,7 @@ https://cloud.minapp.com/oserve/v1/file/ var request = require('request'); var opt = { - uri: 'https://cloud.minapp.com/oserve/v1/file/', + uri: 'https://cloud.minapp.com/oserve/v2.2/file/', method: 'GET', headers: { Authorization: `Bearer ${token}` @@ -147,7 +160,7 @@ request(opt, function(err, res, body) { ```php **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **参数说明** @@ -235,6 +239,15 @@ curl_close($ch); | order_by | String | N | 以下字段不支持排序:gender, country, province, city, language | | limit | Number | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 | | offset | Number | N | 设置返回资源的起始偏移值,默认为 0 | +| return_total_count | Number | N | 返回结果 meta 中是否返回 total_count,1 为返回,0 为不返回,默认不返回 | + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/oserve/v2.2/miniapp/user_profile/?limit=1&return_total_count=1 +``` > **info** > where 字段的详细说明请查看:[数据模块:数据操作](https://doc.minapp.com/open-api/data/record.html#%E6%9F%A5%E8%AF%A2%E6%95%B0%E6%8D%AE)。 @@ -249,7 +262,7 @@ curl_close($ch); curl -X GET \ -H "Authorization: Bearer 35919068aa799eccdef160e1da4bf21381" \ --data-urlencode '{"test": {"$eq":"test"}}'\ - https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/ + https://cloud.minapp.com/oserve/v2.2/miniapp/user_profile/ ``` {% content "bulkGetSingleUserInfoNode" %} @@ -259,14 +272,15 @@ var request = require("request"); var options = { method: 'GET', - url: 'https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/', + url: 'https://cloud.minapp.com/oserve/v2.2/miniapp/user_profile/', headers: { 'Content-Type': 'application/json', Authorization: 'Bearer 35919068aa799eccf19160e1da4bf2138' }, qs: { - where: JSON.stringify({"test": {"$eq": "test"}}) + where: JSON.stringify({"test": {"$eq": "test"}}), + return_total_count: 1 } }; @@ -281,7 +295,7 @@ var req = request(options, function (error, response, body) { ```php json_encode(['test' => ['$eq' => 'test']]), + 'return_total_count' => '1' ); $url .= http_build_query($condition); @@ -596,7 +611,11 @@ if ($err) { ### 批量修改自定义字段 -`PUT https://cloud.minapp.com/oserve/v2.1/miniapp/user_profile/` +`PUT https://cloud.minapp.com/oserve/v2.2/miniapp/user_profile/` + +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回待更新对象总数,以协助不关心对象总数只关心数据更新结果的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回待更新对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **Query 参数说明** @@ -605,6 +624,7 @@ if ($err) { | where | String | N | 查询语句,参数值应经过 JSON 编码为 JSONString 后,再经过 URL 编码 | | limit | Number | N | 限制单次请求更新的用户数,默认为 20 条,最大可设置为 1000 | | offset | Number | N | 设置更新的偏移值,默认为 0 | +| return_total_count | Integer | N | 返回结果中是否包含 total_count,1 为包含,0 为不包含,默认不包含 | > **info** > where 字段的详细说明请查看:[数据模块:数据操作](https://doc.minapp.com/open-api/data/record.html#%E6%9F%A5%E8%AF%A2%E6%95%B0%E6%8D%AE)。 @@ -623,7 +643,7 @@ if ($err) { ```shell curl -X PUT \ - https://cloud.minapp.com/oserve/v2.1/miniapp/user_profile/ \ + https://cloud.minapp.com/oserve/v2.2/miniapp/user_profile/ \ -H 'Authorization: Bearer 35919068aa799eccdef19160e1da4bf21381d2a2' \ -H 'Content-Type: application/json' \ -d '{"test": "test"}' @@ -636,7 +656,7 @@ var request = require("request"); var options = { method: 'PUT', - url: 'https://cloud.minapp.com/oserve/v2.1/miniapp/user_profile/', + url: 'https://cloud.minapp.com/oserve/v2.2/miniapp/user_profile/', headers: { 'Content-Type': 'application/json', @@ -657,7 +677,7 @@ var req = request(options, function (error, response, body) { ```php 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **提交参数** - parent 内容分类父分类列表查询 - `https://cloud.minapp.com/userve/v1/content/:content_group_id/category/?parent__isnull=true` + `https://cloud.minapp.com/userve/v2.2/content/:content_group_id/category/?parent__isnull=true` - name 内容分类名称的等值查询 - `https://cloud.minapp.com/userve/v1/content/:content_group_id/category/?name=category` + `https://cloud.minapp.com/userve/v2.2/content/:content_group_id/category/?name=category` + +- return_total_count 指定是否在 meta 中返回 total_count + + `https://cloud.minapp.com/userve/v2.2/content/:content_group_id/category/?return_total_count=0` + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/userve/v2.2/content/:content_group_id/category/?limit=1&return_total_count=1 +``` **代码示例** @@ -80,7 +96,7 @@ var axios = require('axios').create({ withCredentials: true }) -axios.get('https://cloud.minapp.com/userve/v1/content/1/category/').then(res => { +axios.get('https://cloud.minapp.com/userve/v2.2/content/1/category/').then(res => { console.log(res.data) }) diff --git a/user-dash/content/content-group.md b/user-dash/content/content-group.md index f6ff6388..1ff0bc31 100644 --- a/user-dash/content/content-group.md +++ b/user-dash/content/content-group.md @@ -36,7 +36,7 @@ axios.get('https://cloud.minapp.com/userve/v1/content/1/').then(res => { **接口** -`GET https://cloud.minapp.com/userve/v1/content/` +`GET https://cloud.minapp.com/userve/v2.2/content/` **提交参数** @@ -44,9 +44,21 @@ axios.get('https://cloud.minapp.com/userve/v1/content/1/').then(res => { 例:查询内容库名称为 "内容库1" 的内容库 - `https://cloud.minapp.com/userve/v1/content/?name=内容库1` + `https://cloud.minapp.com/userve/v2.2/content/?name=内容库1` +- return_total_count 指定是否在 meta 中返回 total_count + 例:指定返回 total_count + + `https://cloud.minapp.com/userve/v2.2/content/?return_total_count=1` + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/userve/v2.2/content/?limit=1&return_total_count=1 +``` **代码示例** @@ -55,7 +67,7 @@ var axios = require('axios').create({ withCredentials: true }) -axios.get('https://cloud.minapp.com/userve/v1/content/',{ +axios.get('https://cloud.minapp.com/userve/v2.2/content/',{ params: { name: '内容库1' } diff --git a/user-dash/content/content.md b/user-dash/content/content.md index 22fc3e70..1b3ce6d8 100644 --- a/user-dash/content/content.md +++ b/user-dash/content/content.md @@ -63,12 +63,24 @@ axios.get('https://cloud.minapp.com/userve/v1/content/1/text/1/').then(res => { **接口** -`GET https://cloud.minapp.com/userve/v1/content/:content_group_id/text/` +`GET https://cloud.minapp.com/userve/v2.2/content/:content_group_id/text/` + +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **提交参数** 内容查询与[数据表接口](../data/record.md)查询保持一致 +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/userve/v2.2/content/:content_group_id/text/?limit=1&return_total_count=1 +``` + **代码示例** ```js @@ -76,7 +88,7 @@ var axios = require('axios').create({ withCredentials: true }) -axios.get('https://cloud.minapp.com/userve/v1/content/1/text/').then(res => { +axios.get('https://cloud.minapp.com/userve/v1/content/2.2/text/').then(res => { console.log(res.data) }) ``` diff --git a/user-dash/data/record.md b/user-dash/data/record.md index 76d8c2ad..65b16858 100644 --- a/user-dash/data/record.md +++ b/user-dash/data/record.md @@ -6,10 +6,14 @@ **接口** -`GET https://cloud.minapp.com/userve/v1/table/:table_id/record/` +`GET https://cloud.minapp.com/userve/v2.2/table/:table_id/record/` 其中 `:table_id` 需替换为你的数据表 ID +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 + **参数说明** Content-Type: `application/json` @@ -20,6 +24,7 @@ Content-Type: `application/json` | order_by | String | N | 对资源进行字段排序 | | limit | Number | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 | | offset | Number | N | 设置返回资源的起始偏移值,默认为 0 | +| return_total_count | Number | N | 返回结果 meta 中是否返回 total_count,1 为返回,0 为不返回,默认不返回 | 例如需要查询价格为 10 元的物品时,我们应该这样构造查询语句: @@ -36,7 +41,7 @@ var axios = require('axios').create({ withCredentials: true }) -axios.get('https://cloud.minapp.com/userve/v1/table/1/record/', {params: {where: {price: {$eq: 10}}}}).then(res => { +axios.get('https://cloud.minapp.com/userve/v2.2/table/1/record/', {params: {where: {price: {$eq: 10}}}}).then(res => { console.log(res.data) }) ``` @@ -79,6 +84,14 @@ axios.get('https://cloud.minapp.com/userve/v1/table/1/record/', {params: {where: } ``` +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/userve/v2.2/table/:table_id/record/?limit=1&return_total_count=1 +``` + ## 排序返回查询数据 查询接口默认按**创建时间倒序**的顺序来返回数据列表,你也可以通过设置 `order_by` 参数来实现。 @@ -87,10 +100,10 @@ axios.get('https://cloud.minapp.com/userve/v1/table/1/record/', {params: {where: ``` # 顺序 -https://cloud.minapp.com/userve/v1/table/:table_id/record/?order_by=created_at +https://cloud.minapp.com/userve/v2.2/table/:table_id/record/?order_by=created_at # 倒序 -https://cloud.minapp.com/userve/v1/table/:table_id/record/?order_by=-created_at +https://cloud.minapp.com/userve/v2.2/table/:table_id/record/?order_by=-created_at ``` ## 获取数据项 diff --git a/user-dash/file/file-category.md b/user-dash/file/file-category.md index 9936a1ea..d15778af 100644 --- a/user-dash/file/file-category.md +++ b/user-dash/file/file-category.md @@ -69,7 +69,7 @@ axios.get('https://cloud.minapp.com/userve/v1/file-category/5a1bb2ed7026d950ca7d **接口** -`GET https://cloud.minapp.com/userve/v1/file-category/` +`GET https://cloud.minapp.com/userve/v2.2/file-category/` **参数说明** @@ -80,6 +80,15 @@ Content-Type: `application/json` | order_by | String | N | 排序(支持 `created_at` 进行排序)| | limit | Number | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 | | offset | Number | N | 设置返回资源的起始偏移值,默认为 0 | +| return_total_count | Number | N | 返回结果 meta 中是否返回 total_count,1 为返回,0 为不返回,默认不返回 | + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/userve/v2.2/file-category/?limit=1&return_total_count=1 +``` **代码示例** @@ -88,7 +97,7 @@ var axios = require('axios').create({ withCredentials: true }) -axios.get('https://cloud.minapp.com/userve/v1/file-category/').then(res => { +axios.get('https://cloud.minapp.com/userve/v2.2/file-category/').then(res => { console.log(res.data) }) ``` @@ -116,7 +125,7 @@ axios.get('https://cloud.minapp.com/userve/v1/file-category/').then(res => { } ``` -字段 `files` 在返回中有两个地方出现;在 `meta` 中表示应用上传文件的数量总和;在 `objects` 中表示每个分类下的上传文件的数量。 +字段 `files` 在返回中有两个地方出现;在 `meta` 中表示应用上传文件的数量总和;在 `objects` 中表示每个分类下的上传文件的数量,同时字段 `files` 从 v2.2 版本开始仅在 return_total_count 为 1 时返回。 ## 修改文件分类 diff --git a/user-dash/file/file.md b/user-dash/file/file.md index e5c54eb1..3fbea3ab 100644 --- a/user-dash/file/file.md +++ b/user-dash/file/file.md @@ -47,7 +47,11 @@ axios.get('https://cloud.minapp.com/userve/v1/file/5a1ba9c1fff1d651135e5ff1/').t **接口** -`GET https://cloud.minapp.com/userve/v1/file/` +`GET https://cloud.minapp.com/userve/v2.2/file/` + +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **参数说明** @@ -58,6 +62,15 @@ Content-Type: `application/json` | order_by | String | Y | 排序(支持 `created_at` 进行排序)| | limit | Number | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 | | offset | Number | N | 设置返回资源的起始偏移值,默认为 0 | +| return_total_count | Number | N | 返回结果 meta 中是否返回 total_count,1 为返回,0 为不返回,默认不返回 | + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/userve/v2.2/file/?limit=1&return_total_count=1 +``` **代码示例** @@ -66,7 +79,7 @@ var axios = require('axios').create({ withCredentials: true }) -axios.get('https://cloud.minapp.com/userve/v1/file/', { +axios.get('https://cloud.minapp.com/userve/v2.2/file/', { params: { order_by: '-created_at', category: '5a1ba7b708443e7fc5f2fb18' diff --git a/user-dash/user.md b/user-dash/user.md index 7a945860..1bc6ace3 100644 --- a/user-dash/user.md +++ b/user-dash/user.md @@ -4,22 +4,31 @@ **接口** -`GET https://cloud.minapp.com/userve/v2.0/miniapp/user_profile/` +`GET https://cloud.minapp.com/userve/v2.2/miniapp/user_profile/` + +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **参数说明** | 参数 | 类型 | 必填 | 说明 | | :--------- | :----- | :-- | :-- | -| created_at | String | N | 用户创建的时间,值为时间戳。查询创建时间大于等于 2017-01-01 的用户 `created_at__gte=1483228800`,查询创建时间小于等于 2017-01-01 的用户:`created_at__lte=1483228800` | -| gender | Number | N | 户的性别,其中 `1` 表示男,`2` 表示女 | -| group | String | N | 给定用户组 ID 查询在用户组下的用户列表。只支持 `in` 查询:`group__in=258,360`| -| limit | Number | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 | -| nickname | String | N | 用户的微信昵称,支持等值查询 `nickname=Tom`, 模糊查询 `nickname__contains=Tom` | -| offset | Number | N | 设置返回资源的起始偏移值,默认为 0 | -| openid | String | N | 用户的 OpenID | -| order_by | String | N | 排序(支持 `created_at` 进行排序) | -| unionid | String | N | 用户的 UnionID | -| user_id | String | N | 用户 ID (对应 _userprofile 表中的 id 字段) | +| 参数 | 类型 | 必填 | 说明 | +| :------- | :----- | :-- | :-- | +| where | String | N | 查询语句,参数值应经过 JSON 编码为 JSONString 后,再经过 URL 编码 | +| order_by | String | N | 以下字段不支持排序:gender, country, province, city, language | +| limit | Number | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 | +| offset | Number | N | 设置返回资源的起始偏移值,默认为 0 | +| return_total_count | Number | N | 返回结果 meta 中是否返回 total_count,1 为返回,0 为不返回,默认不返回 | + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/userve/v2.2/miniapp/user_profile/?limit=1&return_total_count=1 +``` **代码示例** @@ -28,12 +37,13 @@ var axios = require('axios').create({ withCredentials: true }) -axios.get('https://cloud.minapp.com/userve/v2.0/miniapp/user_profile/', { +axios.get('https://cloud.minapp.com/userve/v2.2/miniapp/user_profile/', { params: { nickname__contains: 'Tom', gender: 1, created_at__gt: 1483228800, order_by: '-created_at', + return_total_count: 1 } }).then(res => { console.log(res.data) @@ -114,7 +124,11 @@ axios.get('https://cloud.minapp.com/userve/v2.0/miniapp/user_profile/36619758/') ## 批量修改自定义字段 -`PUT https://cloud.minapp.com/userve/v2.1/miniapp/user_profile/` +`PUT https://cloud.minapp.com/userve/v2.2/miniapp/user_profile/` + +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回待更新对象总数,以协助不关心对象总数只关心数据更新结果的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回待更新对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **Query 参数说明** @@ -123,6 +137,7 @@ axios.get('https://cloud.minapp.com/userve/v2.0/miniapp/user_profile/36619758/') | where | String | N | 查询语句,参数值应经过 JSON 编码为 JSONString 后,再经过 URL 编码 | | limit | Number | N | 限制单次请求更新的用户数,默认为 20 条,最大可设置为 1000 | | offset | Number | N | 设置更新的偏移值,默认为 0 | +| return_total_count | Integer | N | 返回结果中是否包含 total_count,1 为包含,0 为不包含,默认不包含 | > **info** > where 字段的详细说明请查看:[数据模块:数据操作](https://doc.minapp.com/user-dash/data/record.html#%E6%9F%A5%E8%AF%A2%E6%95%B0%E6%8D%AE)。 @@ -140,7 +155,7 @@ var axios = require('axios').create({ withCredentials: true }) -axios.put('https://cloud.minapp.com/userve/v2.1/miniapp/user_profile/', { +axios.put('https://cloud.minapp.com/userve/v2.2/miniapp/user_profile/', { test: 'test' }).then(res => { console.log(res.data) diff --git a/web-api/content/content-category.md b/web-api/content/content-category.md index dc7a5c37..0e5b7cf8 100644 --- a/web-api/content/content-category.md +++ b/web-api/content/content-category.md @@ -47,11 +47,24 @@ curl -X GET \ **接口** -`GET /hserve/v1/content/category/` +`GET /hserve/v2.2/content/category/` + +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **请求参数** - `content_group_id` 内容库列表,必选参数。 +- `return_total_count` 指定是否在返回结果 meta 中返回 total_count + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/hserve/v2.2/content/category/?limit=1&return_total_count=1 +``` **请求示例** ```shell @@ -59,7 +72,7 @@ curl -X GET \ -H "Authorization: Hydrogen-r1 {{AccessToken}}" \ -H "X-Hydrogen-Client-ID: {{ClientID}}" \ -H "Content-Type: application/json" \ - https://{{服务器域名}}/hserve/v1/content/category/?content_group_id=1 + https://{{服务器域名}}/hserve/v2.2/content/category/?content_group_id=1 ``` **返回参数说明** @@ -73,7 +86,7 @@ curl -X GET \ | limit | integer | 每次请求返回的最大记录数目 | | previous | string | 上一页地址 | | next | string | 下一页地址 | -| total_count | integer | 记录总数目 | +| total_count | integer | 记录总数目,仅当 return_total_count 为 1 时返回 | **返回示例** diff --git a/web-api/content/content-group.md b/web-api/content/content-group.md index dcd4d8dd..94bd096e 100644 --- a/web-api/content/content-group.md +++ b/web-api/content/content-group.md @@ -31,7 +31,19 @@ https://{{服务器域名}}/hserve/v1/content/group/1/ **接口** -`GET /hserve/v1/content/group/` +`GET /hserve/v2.2/content/group/` + +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/hserve/v2.2/content/group/?limit=1&return_total_count=1 +``` **请求示例** @@ -40,7 +52,7 @@ curl -X GET \ -H "Authorization: Hydrogen-r1 {{AccessToken}}" \ -H "X-Hydrogen-Client-ID: {{ClientID}}" \ -H "Content-Type: application/json" \ -https://{{服务器域名}}/hserve/v1/content/group/ +https://{{服务器域名}}/hserve/v2.2/content/group/ ``` **返回参数说明** @@ -53,7 +65,7 @@ https://{{服务器域名}}/hserve/v1/content/group/ | limit | integer | 每次请求返回的最大记录数目 | | previous | string | 上一页地址 | | next | string | 下一页地址 | -| total_count | integer | 记录总数目 | +| total_count | integer | 记录总数目,仅当 return_total_count 为 1 时返回该字段 | **返回示例** diff --git a/web-api/content/content.md b/web-api/content/content.md index 102479ee..4203a4f1 100644 --- a/web-api/content/content.md +++ b/web-api/content/content.md @@ -2,11 +2,16 @@ **接口** -`GET /hserve/v2.0/content/detail/` +`GET /hserve/v2.2/content/detail/` + +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **请求参数** * `where` 查询语句 * `order_by` 排序字段 + * `return_total_count` 指定是否在返回结果 meta 中返回 total_count **以下参数需二选一** 可选: @@ -15,6 +20,14 @@ `where` 可参考[查询数据](./query-record.md)中的使用方式 +开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/hserve/v2.2/content/detail/?limit=1&return_total_count=1 +``` + **请求示例** ```shell @@ -22,7 +35,7 @@ curl -X GET \ -H "X-Hydrogen-Client-ID: {{ClientID}}" \ -H "Authorization: Hydrogen-r1 {{AccessToken}}" \ -H "Content-Type: application/json" \ -https://{{服务器域名}}/hserve/v2.0/content/detail/?content_group_id=1548659930013242 +https://{{服务器域名}}/hserve/v2.2/content/detail/?content_group_id=1548659930013242 ``` **返回参数说明** @@ -42,7 +55,7 @@ https://{{服务器域名}}/hserve/v2.0/content/detail/?content_group_id=1548659 | limit | integer | 每次请求返回的最大记录数目 | | previous | string | 上一页地址 | | next | string | 下一页地址 | -| total_count | integer | 记录总数目 | +| total_count | integer | 记录总数目,仅当 return_total_count 为 1 时返回 | **返回示例** diff --git a/web-api/data/delete-record.md b/web-api/data/delete-record.md index 7db3ba4b..e2944aab 100755 --- a/web-api/data/delete-record.md +++ b/web-api/data/delete-record.md @@ -31,13 +31,17 @@ curl -X DELETE \ **接口** -`DELETE /hserve/v2.0/table/:table_name/record/` +`DELETE /hserve/v2.2/table/:table_name/record/` 其中 `:table_name` 需替换为你的数据表名称,`record_id` 需替换为你的记录 ID > **info** > 当删除的数据大于 1000 条时,不支持使用触发器,且删除操作是异步执行 +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回待删除对象总数,以协助不关心对象总数只关心数据删除结果的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回待删除对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 + **参数说明** Query Parameters: @@ -48,6 +52,7 @@ Query Parameters: | limit | integer | N | 最多删除数 | | offset | integer | N | 从第几条开始删除 | | enable_trigger | integer | N | 是否使用触发器,1 为使用触发器,0 为不使用 | +| return_total_count | integer | N | 返回结果中是否包含 total_count,1 为包含,0 为不包含,默认不包含 | - `where` 可参考[查询数据](./query-record.md)中的使用方式 - `limit`、`offset` 的构造可参考[分页和排序](./limit-and-order.md) @@ -63,7 +68,7 @@ curl -X DELETE \ -H "Content-Type: application/json" \ -G \ --data-urlencode 'where={"string":{"$eq":"he"}}' \ - https://{{服务器域名}}/hserve/v2.0/table/test_table/record/ + https://{{服务器域名}}/hserve/v2.2/table/test_table/record/ ``` **返回参数说明** @@ -74,7 +79,7 @@ curl -X DELETE \ | offset | integer | 与传入参数 offset 一致 | | limit | integer | 与传入参数 limit 一致 | | next | string | 下一次的删除链接,若待删除记录数超过上限,可通过该链接继续删除 | -| total_count | integer | where 匹配的记录数,包括无权限操作记录 | +| total_count | integer | where 匹配的记录数,包括无权限操作记录,仅当 return_total_count 为 1 时返回 | **返回示例** diff --git a/web-api/data/query-record.md b/web-api/data/query-record.md index ac447437..8095d7f0 100755 --- a/web-api/data/query-record.md +++ b/web-api/data/query-record.md @@ -47,10 +47,14 @@ curl -X GET \ **接口** -`GET /hserve/v2.0/table/:table_name/record/` +`GET /hserve/v2.2/table/:table_name/record/` 其中 `:table_name` 需替换为你的数据表名称 +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 + **参数说明** | 参数 | 类型 | 必填 | 说明 | @@ -61,6 +65,7 @@ curl -X GET \ | order_by | string | N | 对资源进行字段排序 | | limit | integer | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 | | offset | integer | N | 设置返回资源的起始偏移值,默认为 0 | +| return_total_count | integer | N | 返回结果 meta 中是否返回 total_count,1 为返回,0 为不返回,默认不返回 | - `keys` 和 `expand` 的构造可参考[字段过滤和扩展](./query-keys-expand.md) - `limit`、`offset` 和 `order_by` 的构造可参考[分页和排序](./limit-and-order.md) @@ -72,7 +77,7 @@ curl -X GET \ -H "X-Hydrogen-Client-ID: {{ClientID}}" \ -H "Authorization: Hydrogen-r1 {{AccessToken}}" \ -H "Content-Type: application/json" \ -https://{{服务器域名}}/hserve/v2.0/table/952728/record/?limit=10&offset=0 +https://{{服务器域名}}/hserve/v2.2/table/952728/record/?limit=10&offset=0 ``` **返回参数说明** @@ -89,7 +94,7 @@ https://{{服务器域名}}/hserve/v2.0/table/952728/record/?limit=10&offset=0 | limit | integer | 每次请求返回的最大记录数目 | | previous | string | 上一页地址 | | next | string | 下一页地址 | -| total_count | integer | 记录总数目 | +| total_count | integer | 记录总数目,仅当 return_total_count 为 1 时返回 | **返回示例** ```json @@ -160,7 +165,7 @@ curl -X GET \ -H "X-Hydrogen-Client-ID: {{ClientID}}" \ -H "Authorization: Hydrogen-r1 {{AccessToken}}" \ -H "Content-Type: application/json" \ - https://{{服务器域名}}/hserve/v2.0/table/test_table/record/?where=%7b%22status%22%3a%7b%22%24eq%22%3a%22deleted%22%7d%7d + https://{{服务器域名}}/hserve/v2.2/table/test_table/record/?where=%7b%22status%22%3a%7b%22%24eq%22%3a%22deleted%22%7d%7d ``` 其中 `%7b%22status%22%3a%7b%22%24eq%22%3a%22deleted%22%7d%7d` 为 `{"status":{"$eq":"deleted"}}` 经过 urlencode 后的值 @@ -174,7 +179,7 @@ curl -X GET \ -H "Content-Type: application/json" \ -G \ --data-urlencode 'where={"status":{"$eq":"deleted"}}' \ - https://{{服务器域名}}/hserve/v2.0/table/test_table/record/ + https://{{服务器域名}}/hserve/v2.2/table/test_table/record/ ``` > **info** @@ -421,3 +426,13 @@ curl -X GET \ ] } ``` + +### 获取查询对象总数 + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://cloud.minapp.com/hserve/v2.2/table/:table_name/record/?limit=1&return_total_count=1 +``` diff --git a/web-api/data/update-record.md b/web-api/data/update-record.md index 52cf8232..30a27e26 100755 --- a/web-api/data/update-record.md +++ b/web-api/data/update-record.md @@ -244,13 +244,14 @@ curl -X PUT \ **接口** -`PUT /hserve/v2.0/table/:table_name/record/` +`PUT /hserve/v2.2/table/:table_name/record/` 其中 `:table_name` 需替换为你的数据表名称,`record_id` 需替换为你的记录 ID > **info** > 1. 当更新的数据大于 1000 条时,不支持使用触发器,且删除操作是异步执行 > 2. 如需更新 1000 条以上数据,可指定 enable_trigger 为 0 不触发触发器。 +> 3. 该接口支持通过参数 return_total_count 指定是否返回待更新对象总数,以协助不关心对象总数只关心数据更新结果的开发者提升接口响应速度。同时,从 v2.2 版本开始该接口默认不返回待更新对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **参数说明** @@ -262,6 +263,7 @@ Query Parameters: | limit | integer | N | 最多更新数 | | offset | integer | N | 从第几条开始更新 | | enable_trigger | integer | N | 是否使用触发器,1 为使用触发器,0 为不使用 | +| return_total_count | integer | N | 返回结果中是否包含 total_count,1 为包含,0 为不包含,默认不包含 | - `where` 可参考[查询数据](./query-record.md)中的使用方式 - `limit`、`offset` 的构造可参考[分页和排序](./limit-and-order.md) @@ -276,7 +278,7 @@ curl -X PUT \ -H "Authorization: Hydrogen-r1 {{AccessToken}}" \ -H "Content-Type: application/json" \ -d '{"age": {"$incr_by": 1}}' \ - "https://{{服务器域名}}/hserve/v2.0/table/test_table/record/?where=%7b%22nickname%22%3a%7b%22%24eq%22%3a%22hgz%22%7d%7d" + "https://{{服务器域名}}/hserve/v2.2/table/test_table/record/?where=%7b%22nickname%22%3a%7b%22%24eq%22%3a%22hgz%22%7d%7d" ``` 其中 `%7b%22nickname%22%3a%7b%22%24eq%22%3a%22hgz%22%7d%7d` 为 `{"nickname":{"$eq":"hgz"}}` 经过 urlencode 后的结果 @@ -289,7 +291,7 @@ curl -X PUT \ | 参数 | 说明 | | :---------- | :------------------------------------------------------------- | | succeed | 成功更新记录数 | -| total_count | where 匹配的记录数,包括无权限操作记录 | +| total_count | where 匹配的记录数,包括无权限操作记录,仅当 return_total_count 为 1 时返回 | | offset | 与传入参数 offset 一致 | | limit | 与传入参数 limit 一致 | | next | 下一次的更新链接,若待更新记录数超过上限,可通过该链接继续更新 | diff --git a/web-api/file/file-category.md b/web-api/file/file-category.md index 93408602..7f437824 100644 --- a/web-api/file/file-category.md +++ b/web-api/file/file-category.md @@ -36,7 +36,11 @@ curl -X GET \ **接口** -`GET /hserve/v1.3/file-category/` +`GET /hserve/v2.2/file-category/` + +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **参数说明** @@ -45,6 +49,15 @@ curl -X GET \ | order_by | string | N | 排序(支持 `created_at` 进行排序)| | limit | integer | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 | | offset | integer | N | 设置返回资源的起始偏移值,默认为 0 | +| return_total_count | integer | N | 返回结果 meta 中是否返回 total_count,1 为返回,0 为不返回,默认不返回 | + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://{{服务器域名}}/hserve/v2.2/file-category/?limit=1&return_total_count=1 +``` **请求示例** ```shell @@ -52,7 +65,7 @@ curl -X GET \ -H "X-Hydrogen-Client-ID: {{ClientID}}" \ -H "Authorization: Hydrogen-r1 {{AccessToken}}" \ -H "Content-Type: application/json" \ - https://{{服务器域名}}/hserve/v1.3/file-category/?order_by=-created_at + https://{{服务器域名}}/hserve/v2.2/file-category/?order_by=-created_at ``` **返回参数说明** @@ -66,7 +79,7 @@ curl -X GET \ | limit | integer | 每次请求返回的最大记录数目 | | previous | string | 上一页地址 | | next | string | 下一页地址 | -| total_count | integer | 记录总数目 | +| total_count | integer | 记录总数目,仅当 return_total_count 为 1 时返回 | **返回示例** @@ -91,4 +104,4 @@ curl -X GET \ } ``` -字段 `files` 在返回中有两个地方出现;在 `meta` 中表示应用上传文件的数量总和;在 `objects` 中表示每个分类下的上传文件的数量。 +字段 `files` 在返回中有两个地方出现;在 `meta` 中表示应用上传文件的数量总和;在 `objects` 中表示每个分类下的上传文件的数量,同时字段 `files` 从 v2.2 版本开始仅在 return_total_count 为 1 时返回。 diff --git a/web-api/file/file.md b/web-api/file/file.md index d7d09b83..765d9a23 100644 --- a/web-api/file/file.md +++ b/web-api/file/file.md @@ -44,11 +44,15 @@ curl -X GET \ ## 获取文件列表 > **info** -> v2.1 接口规范了返回参数的输出,使用更方便。原[获取文件列表 v1.3 接口](#获取文件列表-v13)已被废弃。 +> v2.2 接口规范了返回参数的输出,使用更方便。原[获取文件列表 v1.3 接口](#获取文件列表-v13)已被废弃。 **接口** -`GET /hserve/v2.1/uploaded-file/` +`GET /hserve/v2.2/uploaded-file/` + +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 **参数说明** @@ -57,6 +61,15 @@ curl -X GET \ | order_by | string | Y | 排序(支持 `created_at` 进行排序)| | limit | integer | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 | | offset | integer | N | 设置返回资源的起始偏移值,默认为 0 | +| return_total_count | integer | N | 返回结果 meta 中是否返回 total_count,1 为返回,0 为不返回,默认不返回 | + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://{{服务器域名}}/hserve/v2.2/uploaded-file/?limit=1&return_total_count=1 +``` **请求示例** @@ -67,7 +80,7 @@ curl -X GET \ -H "Content-Type: application/json" \ -G \ --data-urlencode "order_by=-created_at" \ - https://{{服务器域名}}/hserve/v2.1/uploaded-file/ + https://{{服务器域名}}/hserve/v2.2/uploaded-file/ ``` **返回示例** diff --git a/web-api/user.md b/web-api/user.md index 6529d4fe..c69b8493 100644 --- a/web-api/user.md +++ b/web-api/user.md @@ -224,8 +224,19 @@ curl -X GET \ **接口** -`GET /hserve/v2.0/user/info/` +`GET /hserve/v2.2/user/info/` +> **info** +> 该接口支持通过参数 return_total_count 指定是否返回查询对象总数,以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。 +同时,从 v2.2 版本开始该接口默认不返回查询对象总数,欲获取总数的开发者需要显式指定 return_total_count 参数。 + +若开发者只需要获取对象总数,则可以通过设置 `limit=1` 以及 `return_total_count=1` 来达到该效果,total_count 可从返回的 meta 中获取 + +请求示例: + +``` +https://{{服务器域名}}/hserve/v2.2/user/info/?limit=1&return_total_count=1 +``` **请求示例** ```shell @@ -233,7 +244,7 @@ curl -X GET \ -H "X-Hydrogen-Client-ID: {{ClientID}}" \ -H "Authorization: Hydrogen-r1 {{AccessToken}}" \ -H "Content-Type: application/json" \ - https://{{服务器域名}}/hserve/v2.0/user/info/ + https://{{服务器域名}}/hserve/v2.2/user/info/ ``` **返回示例** @@ -263,7 +274,7 @@ curl -X GET \ "total_count": 140, "limit": 1, "previous": null, - "next": "/userve/v2.0/user/info/?limit=1&offset=1", + "next": "/userve/v2.2/user/info/?limit=1&offset=1", "offset": 0 } }