graphql/file-upload

graphql-file-upload

https://travis-ci.org/graphql-services/graphql-file-upload.svg?branch=master](https://travis-ci.org/graphql-services/graphql-file-upload)

这是一个集成GraphQL连接器的文件上传微服务，支持文件的上传与下载，并通过GraphQL API与后端服务进行数据交互。

核心功能

• 通过POST /upload接口以二进制方式上传文件
• 通过GET /:id接口根据文件ID下载文件
• 上传文件时自动向指定GraphQL服务发送createFile mutation
• 下载文件时自动向指定GraphQL服务发送file query
• 支持通过环境变量配置GraphQL服务地址、文件存储方式（如S3）及主机URL

使用场景

适用于需要文件上传功能且与GraphQL后端集成的应用场景，例如：

• 内容管理系统中的媒体文件上传
• 用户头像、附件等文件的存储与获取
• 与GraphQL服务联动的文件管理模块

配置说明

通过环境变量进行配置：

• GRAPHQL_URL：GraphQL服务的URL（用于发送createFile mutation和file query）
• FILESTORAGE_URL：文件存储地址（支持S3等，参考https://www.npmjs.com/package/file-storage%EF%BC%89
• HOST_URL：生成文件完整URL的主机地址（如http://files.example.com）

Docker部署示例

docker-compose.yml

yaml
version: '2'
services:
  file-uploader:
    image: graphql/file-upload
    ports:
      - 3000:80
    environment:
      - GRAPHQL_URL=http://api.example.com/graphql
      - FILESTORAGE_URL=s3://asdadf:adfdf@bucket_name?region=us-east-1
      - HOST_URL=http://files.example.com

GraphQL连接说明

上传文件

每次通过POST /upload上传文件时，会向GRAPHQL_URL发送createFile mutation。
默认mutation格式如下：

graphql
mutation createFile($input: FileRawCreateInput!) {
    createFile(input:$input) {
        id
        uid
        size
        contentType
        url
    }
}

变量示例：

json
{
    "input": {
        "uid": "abcdefafdsdfs",
        "size": 123,  # 来自请求头的content-length
        "contentType": "image/jpg",  # 来自请求头的content-type
        "url": "http://files.example.com/abcdefafdsdfs"
    }
}

也可通过查询字符串添加额外输入变量（如POST /upload?blah=foo），变量会自动添加到input中。

获取文件

每次通过GET /:id获取文件时，会向GRAPHQL_URL发送file query。
默认query格式如下：

graphql
query file($uid: ID) {
    file(filter: { uid: $uid }) {
        uid
        size
        contentType
    }
}

变量示例：

json
{
    "uid": "abcdefafdsdfs"
}