实用程序 Utilities

Directus 中 Utilities 集合的 REST 和 GraphQL API 文档。实用程序是位于 API 中的各种辅助端点。

生成哈希

为给定的字符串生成哈希。

请求正文

string Required
要散列的字符串。

返回

哈希字符串。

REST API

POST /utils/hash/generate
示例
json
// POST /utils/hash/generate

{
  "string": "Hello World!"
}

GraphQL

POST /graphql/system
graphql
type Mutation {
 utils_hash_generate(string: String!): String
}
示例
graphql
mutation {
 utils_hash_generate(string: "Hello World!")
}

验证哈希

使用哈希验证字符串。

请求正文

string Required
源字符串。

hash Required
您要验证的哈希值。

Returns

Boolean.

REST API

POST /utils/hash/verify
示例
json
// POST /utils/hash/verify

{
  "string": "Hello World!",
  "hash": "$arg...fEfM"
}

GraphQL

POST /graphql/system
graphql
type Mutation {
 utils_hash_verify(hash: String!, string: String!): Boolean
}

手动对集合中的项目进行排序

如果集合具有排序字段,则此实用程序可用于按该手动顺序移动项目。

请求正文

item Required
您在集合中移动的项目的主键。

to Required
您也正在移动源项目的项目的主键。

Returns

Empty body.

REST API

POST /utils/sort/:collection
示例
json
// POST /utils/sort/articles

{
  "item": 16,
  "to": 51
}

GraphQL

POST /graphql/system
graphql
type Mutation {
 utils_sort(collection: String!, item: ID!, to: ID!): Boolean
}
示例
graphql
mutation {
 utils_sort(collection: "articles", item: 16, to: 51)
}

从文件导入数据

将 JSON 或 CSV 文件中的多条记录导入到集合中。 依赖于 multipart/form-data 编码请求,就像常规文件上传一样。 检查 上传文件 了解更多信息。

导入端点期望文件结构匹配导出查询参数。 对于 JSON,这是一个对象数组,其中每个对象都是一个项目。 对于 CSV,第一行必须是列标题。

请求正文

multipart/form-data 请求中发送文件。 有关详细信息,请参阅 上传文件

Returns

Empty body.

REST API

POST /utils/import/:collection
示例
POST /utils/import/articles

Content-Type: multipart/form-data; charset=utf-8; boundary=__X_BOUNDARY__
Content-Length: 3442422

--__X_BOUNDARY__
Content-Disposition: form-data; name="file"; filename="articles.csv"
Content-Type: text/csv

"id","title","another","created_by"
1,"My First Articled","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
2,"My Second Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
3,"My Updated Third Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
4,"My Fourth Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
5,"My Fifth Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
...

GraphQL

n/a


将数据导出到文件

将较大的数据集导出到文件库中的文件

查询参数

不使用任何查询参数。

请求正文

format Required
将导出保存到什么文件格式。 csvxmljsonyaml 之一。

query Required
用于导出的查询对象。 支持全局查询参数

file File Object
部分文件对象来调整导出文件的保存位置/方式。

Returns

Empty body

REST API

POST /utils/export/:collection
示例
POST /utils/export/articles
json
{
  "query": {
    "filter": {
      "status": {
        "_eq": "published"
      }
    }
  },
  "file": {
    "folder": "34e95c19-cc50-42f2-83c8-b97616ac2390"
  }
}

GraphQL

n/a


清除内部缓存

重置 Directus 的数据和模式缓存。 此端点仅对管理员用户可用。

请求正文

n/a

Returns

Empty body

REST API

POST /utils/cache/clear

GraphQL

graphql
mutation {
 utils_cache_clear
}