设置 Setting

Directus 中设置集合的 REST 和 GraphQL API 文档。设置是存储在数据库中的键值对，控制项目的不同方面。 只有管理员有权管理设置。

设置的对象

id uuid
设置的主键。

project_name string
项目名称，显示在 Admin App 中。

project_descriptor string
项目的描述符，显示在 Admin App 中。

project_url string
链接到该项目附带的(公共)网站。

project_color string
当前项目的品牌颜色。

project_logo many-to-one
当前项目的主要标志。多对一到 文件。

public_foreground many-to-one
Admin App 公共页面的前景图像。多对一到 文件。

public_background many-to-one
Admin App 公共页面的背景图片。多对一到 文件。

public_note string
管理应用程序的公共页面上显示的注释。支持降价。

auth_login_attempts integer
允许用户尝试登录的频率。之后用户将被暂停。

auth_password_policy RegEx
必须通过哪些正则表达式密码才能有效。

storage_asset_transform string
如果允许在 资产端点 上使用转换端点。 all、none 或 presets 之一。

storage_asset_presets array
资产端点中存在哪些预设键。

custom_css string
覆盖应用程序默认样式的 CSS 规则。

storage_default_folder uuid
上传文件的文件夹。不影响现有文件。

basemaps array
自定义图块以覆盖 Mapbox 默认值。

mapbox_key string
Mapbox 访问令牌。

module_bar array
全局启用/添加了哪些模块。

translation_strings array
翻译字符串的键和翻译。

custom_aspect_ratios array
图像编辑器中的自定义纵横比。

json
{
  "data": {
    "id": 1,
    "project_name": "Directus",
    "project_descriptor": "Application",
    "project_url": null,
    "project_color": null,
    "project_logo": null,
    "public_foreground": null,
    "public_background": null,
    "public_note": null,
    "auth_login_attempts": 25,
    "auth_password_policy": null,
    "storage_asset_transform": "all",
    "storage_asset_presets": [
      {
        "key": "small",
        "fit": "cover",
        "width": 200,
        "height": 161,
        "quality": 80,
        "withoutEnlargement": false
      }
    ],
    "custom_css": null,
    "storage_default_folder": null,
    "basemaps": null,
    "mapbox_key": null,
    "module_bar": null,
    "translation_strings": [
      {
        "key": "draft",
        "translations": {
          "de-DE": "Entwurf",
          "en-US": "Draft"
        }
      }
    ],
    "custom_aspect_ratios": [
      {
        "text": "16:10",
        "value": 1.6
      }
    ]
  }
}

检索设置

查询参数

支持所有全局查询参数。

返回

返回 设置对象。

REST API

GET /settings

GraphQL

POST /graphql/system
graphql
type Query {
 settings: directus_settings
}
示例
graphql
query {
 settings {
  project_name
 }
}

更新设置

查询参数

支持所有全局查询参数。

请求正文

部分 设置对象。

返回

返回 设置对象。

REST API

PATCH /settings
示例
json
// PATCH /settings

{
  "project_url": "https://示例.com/"
}

GraphQL

POST /graphql/system
graphql
type Mutation {
 update_settings(data: update_directus_settings_input!): directus_settings
}
示例
graphql
mutation {
 update_settings(data: { project_url: "https://example.com" }) {
  project_name
  project_url
 }
}