REST API:上传文件

¥REST API: Upload files

媒体库功能由 upload 包在 Strapi 的后端服务器中提供支持。要将文件上传到 Strapi，你可以直接从管理面板使用媒体库，也可以使用 REST API，具有以下可用端点：

¥The Media Library feature is powered in the back-end server of Strapi by the upload package. To upload files to Strapi, you can either use the Media Library directly from the admin panel, or use the REST API, with the following available endpoints :

方法	路径	描述
得到	`/api/upload/files`	获取文件列表
得到	`/api/upload/files/:id`	获取特定文件
邮政	`/api/upload`	上传文件
邮政	`/api/upload?id=x`	更新文件信息
删除	`/api/upload/files/:id`	删除文件

注意

文件夹是管理面板专用功能，不属于 Content API（REST 或 GraphQL）。通过 REST 上传的文件位于自动创建的 "API 上传" 文件夹中。

¥Folders are an admin panel-only feature and are not part of the Content API (REST or GraphQL). Files uploaded through REST are located in the automatically created "API Uploads" folder.
GraphQL API 不支持上传媒体文件。要上传文件，请使用 REST API 或直接从管理面板中的媒体库添加文件。仍然可以进行一些 GraphQL 修改来更新或删除已上传的媒体文件（有关详细信息，请参阅 GraphQL API 文档）。

¥The GraphQL API does not support uploading media files. To upload files, use the REST API or directly add files from the Media Library in the admin panel. Some GraphQL mutations to update or delete uploaded media files are still possible (see GraphQL API documentation for details).

上传文件

¥Upload files

将一个或多个文件上传到你的应用。

¥Upload one or more files to your application.

files 是唯一可接受的参数，并描述要上传的文件。值可以是缓冲区或流：

¥files is the only accepted parameter, and describes the file(s) to upload. The value(s) can be a Buffer or Stream:

Browser
Node.js

<form>
  
  <input type="file" name="files" />
  <input type="submit" value="Submit" />
</form>

<script type="text/javascript">
  const form = document.querySelector('form');

  form.addEventListener('submit', async (e) => {
    e.preventDefault();

    await fetch('/api/upload', {
      method: 'post',
      body: new FormData(e.target)
    });
  });
</script>

import { FormData } from 'formdata-node';
import fetch, { blobFrom } from 'node-fetch';

const file = await blobFrom('./1.png', 'image/png');

const form = new FormData();

form.append('files', file, "1.png");

const response = await fetch('http://localhost:1337/api/upload', {

  method: 'post',
  body: form,
});

提醒

你必须在请求正文中发送 FormData。

¥You have to send FormData in your request body.

上传入口文件

¥Upload entry files

上传一个或多个将链接到特定条目的文件。

¥Upload one or more files that will be linked to a specific entry.

接受以下参数：

¥The following parameters are accepted:

范围	描述
`files`	要上传的文件。该值可以是缓冲区或流。
`path`（可选）	文件将上传到的文件夹（仅在 Strapi-provider-upload-aws-s3 上受支持）。
`refId`	文件将链接到的条目的 ID。
`ref`	文件将链接到的模型的唯一 ID (uid)（请参阅下文）。
`source`（可选）	模型所在插件的名称。
`field`	文件将精确链接到的条目的字段。

例如，给定 Restaurant 模型属性：

¥For example, given the Restaurant model attributes:

/src/api/restaurant/content-types/restaurant/schema.json
{
  // ...
  "attributes": {
    "name": {
      "type": "string"
    },
    "cover": {
      "type": "media",
      "multiple": false,
    }
  }
// ...
}

以下是相应前端的示例代码：

¥The following is an example of a corresponding front-end code:

<form>
  
  <input type="file" name="files" />
  <input type="text" name="ref" value="api::restaurant.restaurant" />
  <input type="text" name="refId" value="5c126648c7415f0c0ef1bccd" />
  <input type="text" name="field" value="cover" />
  <input type="submit" value="Submit" />
</form>

<script type="text/javascript">
  const form = document.querySelector('form');

  form.addEventListener('submit', async (e) => {
    e.preventDefault();

    await fetch('/api/upload', {
      method: 'post',
      body: new FormData(e.target)
    });
  });
</script>

提醒

你必须在请求正文中发送 FormData。

¥You have to send FormData in your request body.

更新文件信息

¥Update fileInfo

更新应用中的文件。

¥Update a file in your application.

fileInfo 是唯一可接受的参数，并描述要更新的文件信息：

¥fileInfo is the only accepted parameter, and describes the fileInfo to update:

import { FormData } from 'formdata-node';
import fetch from 'node-fetch';

const fileId = 50;

const newFileData = {

  alternativeText: 'My new alternative text for this image!',
};

const form = new FormData();

form.append('fileInfo', JSON.stringify(newFileData));

const response = await fetch(`http://localhost:1337/api/upload?id=${fileId}`, {

  method: 'post',
  body: form,
});

型号定义

¥Models definition

向 model（或另一个插件的模型）添加文件属性就像添加新关联一样。

¥Adding a file attribute to a model (or the model of another plugin) is like adding a new association.

以下示例允许你上传并将一个文件附加到 avatar 属性：

¥The following example lets you upload and attach one file to the avatar attribute:

/src/api/restaurant/content-types/restaurant/schema.json

{
  // ...
  {
    "attributes": {
      "pseudo": {
        "type": "string",
        "required": true
      },
      "email": {
        "type": "email",
        "required": true,
        "unique": true
      },
      "avatar": {
        "type": "media",
        "multiple": false,
      }
    }
  }
  // ...
}

以下示例允许你上传并将多张图片附加到 restaurant 内容类型：

¥The following example lets you upload and attach multiple pictures to the restaurant content-type:

/src/api/restaurant/content-types/restaurant/schema.json
{
  // ...
  {
    "attributes": {
      "name": {
        "type": "string",
        "required": true
      },
      "covers": {
        "type": "media",
        "multiple": true,
      }
    }
  }
  // ...
}

上传文件​

上传入口文件​

更新文件信息​

型号定义​

上传文件

上传入口文件

更新文件信息

型号定义