快速入门指南 Quick Start

本快速入门指南旨在帮助您快速启动并运行 Directus 云项目。在此过程中,您将更好地了解 Directus 是什么,设置您的免费 Directus 云帐户,获得应用程序和 API 的“动手介绍”,并找到更多资源进行深入研究。

1. 创建云帐户并登录

首先,您需要在 Directus Cloud创建帐户并登录

您的 Directus 云帐户允许您创建和管理任意数量的社区和标准项目。 通过让您可以选择使用 GitHub 自动创建和登录您的免费云帐户,我们让生活变得更轻松。 如果您没有 GitHub 帐户或不想使用此登录方法,也可以使用电子邮件和密码登录。

首次登录云帐户时,系统会提示您创建团队。 团队完全可以自由创建。 每个 Directus 云项目都存在于一个团队的范围内。 它们允许您根据需要组织团队成员、项目和项目计费。

创建团队后,就该创建免费的社区云项目了!

2. 创建和访问项目

要创建社区项目,请按照以下步骤操作:

  1. 打开仪表板标题中的团队菜单,然后选择或创建 所需的团队。
  2. 导航到 “项目”,然后单击 “创建项目”
  3. 设置项目名称。
  4. 选择社区层。
  5. 滚动到屏幕底部并选择 “空项目” 启动模板。
    注意: “演示项目” 添加了虚拟数据以进行深入的功能演示。
  6. 点击 “创建项目”

构建云项目大约需要 90 秒。在此期间,将向与您的云帐户关联的电子邮件发送一个链接。该电子邮件将包含您的项目 URL 以及用于登录的电子邮件和密码。如果您使用 GitHub 创建帐户,这将是您的 GitHub 电子邮件。构建完成后,就该登录了!

  1. 您可以从 Cloud Dashboard 中访问项目 或将 URL 输入 你的浏览器。
  2. 使用电子邮件中的用户名和密码登录。

检查所有收件箱文件夹
由于某些电子邮件提供商使用的算法,包含您的项目登录信息的电子邮件最终可能会放在另一个文件夹中,例如“社交”或“促销”。

了解有关云项目的更多信息\

3. 创建一个集合

登录后,您会看到创建您的第一个 Collection 的选项。

  1. 导航到内容模块。
  2. 点击 “创建收藏”,会出现一个侧边菜单。
  3. 填写名称。 为了这个演示,我们将其称为“文章”,但请随意将其设为您自己的!
  4. 其他选项保持默认。 单击 arrow_forward 将打开 “可选系统字段” 菜单。 暂时将此菜单中的值保持为默认值,关闭。 您可以稍后调整它们。
  5. 点击菜单标题中的check

4. 创建字段

创建第一个集合后,是时候开始添加一些 Fields

  1. 导航到设置模块 > 数据模型 > Collection-Name
  2. 点击 “创建字段” 按钮并选择 “输入” 字段类型。
  3. Key下填写字段名称。 我们将调用我们的字段title。 Directus 提供了强大的字段自定义选项,但现在让我们坚持使用默认值。
  4. 选择 “保存”

了解有关字段的更多信息\

5. 创建一个项目

现在我们已经配置了一个带有字段的集合,是时候添加一个 Item

  1. 导航到内容模块。
  2. 点击页眉中的add,打开Item Page。
  3. 根据需要填写字段值。
  4. 点击右上角的check保存你的Item。

了解更多关于物品的信息\

6. 设置角色和权限

Directus 带有两个内置角色:公共和管理员。公共角色确定将哪些数据返回给未经身份验证的用户。 Public 关闭了所有权限,并且可以通过完全精细的控制重新配置,以准确地公开您希望未经身份验证的用户看到的内容。 Admin 角色具有完全权限,并且无法更改。除了这些内置角色之外,还可以创建任意数量的新角色,所有角色都具有完全自定义的细粒度权限。

默认情况下,输入 Directus 的内容将被视为私有内容。所以权限总是开始设置为默认的 block No Access,完全可以根据需要重新配置。因此,为了让 API 返回我们的项目,让我们添加一些读取权限。为简单起见,我们将对公共角色执行此操作,而不是创建新角色。

  1. 导航至设置模块 > 角色和权限 > 公开
  2. 单击所需集合上visibility 图标下的block。在我们的例子中,集合名称是 article
  3. 单击 “所有访问权限” 以授予公共角色对此集合中的项目的完全读取权限。

了解有关角色和权限的更多信息

7. 连接到 API

现在您的项目中有一些公开的内容,是时候开始在外部使用这些内容了! 可以通过多种方式访问数据,包括 REST 和 GraphQL API 端点。 在这种情况下,我们将使用/items/ REST API 端点 来检索我们刚刚创建的项目。

  1. 打开http://your-project-url.directus.app/items/articles。您可以使用浏览器或 API 工具,例如 PostmanPaw

它就在那里! 您刚刚创建的文章项目正在以漂亮的 JSON 格式提供,可以随时随地使用!

json
{
  "data": [
    {
      "id": 1,
      "title": "Hello World!"
    }
  ]
}

在这个例子中,我们使用 API 发出了一个超级简单的读取请求,但还有更多! REST 和 GraphQL API 为数据模型提供了详尽的端点,您可以在应用程序中执行的每一个操作都可以通过 API 完成。 实际上,App 只是一个由 API 驱动的 GUI。

了解有关 API 的更多信息\