edit

厂家共享存储

氦氪为厂家提供厂家下所有用户可读写的数据存储接口,您可以将需要在用户间共享的记录保存在此。 该接口为用户API(地址为user-openapi.hekr.me)。

Warning

该接口厂家下所有用户均可访问,请勿保存敏感信息。

保存记录

Tip

您可以自定义任何属性,其中_id(String)为记录唯一标识,您可以自行指定;若未指定, 氦氪将为您自动生成。当指定_id时,如果存在该记录将会更新,如果不存在将创建新记录。

PUT /api/v1/pd HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer {JWT_TOKEN}

{
    "foo": "bar"
}
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "foo": "bar",
  "_id": "c23536df-a233-4d16-a812-7653b8f11e3c"
}

分页查询

Tip

您可以自定义滤参数,例如GET /api/v1/pd?foo=bar 将筛选所有包含foo且值为"bar"的记录

GET /api/v1/pd HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "content": [
    {
      "_id": "ebc09d1e-80a7-467a-acee-fd9f990f061e",
      "foo": "bar"
    }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 1,
  "sort": null,
  "first": true,
  "numberOfElements": 1,
  "size": 20,
  "number": 0
}

请求参数

参数 是否必须 默认 含义
page false 0 第几页(从0开始)
size false 20 每页多少条记录
sort false 排序方法,例如sort=time 按时间升序,sort=time,DESC 按时间倒序

删除记录

DELETE /api/v1/pd/{ids} HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

请求参数

参数 是否必须 默认 含义
ids true 需要删除的记录id,以"," 分隔