如何使用 REST Web 服务上传包含元数据的文件？

我同意 Greg 的观点，即两阶段方法是一个合理的解决方案，但是我会反过来做。我会做：

POST http://server/data/media
body:
{
    "Name": "Test",
    "Latitude": 12.59817,
    "Longitude": 52.12873
}

创建元数据条目并返回如下响应：

201 Created
Location: http://server/data/media/21323
{
    "Name": "Test",
    "Latitude": 12.59817,
    "Longitude": 52.12873,
    "ContentUrl": "http://server/data/media/21323/content"
}

然后，客户端可以使用此 ContentUrl 并对文件数据执行 PUT。

这种方法的好处是，当您的服务器开始因大量数据而不堪重负时，您返回的 url 可以指向具有更多空间/容量的其他服务器。或者，如果带宽是一个问题，您可以实施某种循环方法。

---

仅仅因为您没有将整个请求正文包装在 JSON 中，并不意味着使用 multipart/form-data 在单个请求中发布 JSON 和文件不是 RESTful：

curl -F "metadata=<metadata.json" -F "file=@my-file.tar.gz" http://example.com/add-file

在服务器端：

class AddFileResource(Resource):
    def render_POST(self, request):
        metadata = json.loads(request.args['metadata'][0])
        file_body = request.args['file'][0]
        ...

要上传多个文件，可以为每个文件使用单独的“表单字段”：

curl -F "metadata=<metadata.json" -F "file1=@some-file.tar.gz" -F "file2=@some-other-file.tar.gz" http://example.com/add-file

...在这种情况下，服务器代码将具有 request.args['file1'][0] 和 request.args['file2'][0]

或为许多人重复使用同一个：

curl -F "metadata=<metadata.json" -F "files=@some-file.tar.gz" -F "files=@some-other-file.tar.gz" http://example.com/add-file

...在这种情况下，request.args['files'] 将只是长度为 2 的列表。

或通过单个字段传递多个文件：

curl -F "metadata=<metadata.json" -F "files=@some-file.tar.gz,some-other-file.tar.gz" http://example.com/add-file

...在这种情况下 request.args['files'] 将是一个包含所有文件的字符串，您必须自己解析它 - 不知道该怎么做，但我相信这并不难，或者最好使用以前的方法.

@ 和 < 之间的区别在于 @ 使文件作为文件上传附加，而 < 将文件内容作为文本字段附加。

PS 仅仅因为我使用 curl 作为生成 POST 请求的一种方式，并不意味着无法从 Python 等编程语言发送完全相同的 HTTP 请求或使用任何足够强大的工具。

---

解决该问题的一种方法是将上传设置为两阶段过程。首先，您将使用 POST 上传文件本身，其中服务器将一些标识符返回给客户端（标识符可能是文件内容的 SHA1）。然后，第二个请求将元数据与文件数据相关联：

{
    "Name": "Test",
    "Latitude": 12.59817,
    "Longitude": 52.12873,
    "ContentID": "7a788f56fa49ae0ba5ebde780efe4d6a89b5db47"
}

将文件数据库 base64 编码到 JSON 请求本身将使传输的数据大小增加 33%。根据文件的整体大小，这可能重要也可能不重要。

另一种方法可能是使用原始文件数据的 POST，但在 HTTP 请求标头中包含任何元数据。但是，这有点超出了基本的 REST 操作，对于某些 HTTP 客户端库来说可能更尴尬。

---

我不明白为什么在八年的时间里，没有人发布简单的答案。不是将文件编码为 base64，而是将 json 编码为字符串。然后只需在服务器端解码 json。

在 Javascript 中：

let formData = new FormData();
formData.append("file", myfile);
formData.append("myjson", JSON.stringify(myJsonObject));

使用 Content-Type 发布它：multipart/form-data

在服务器端，正常检索文件，将json作为字符串检索。将字符串转换为对象，无论您使用哪种编程语言，这通常是一行代码。

（是的，效果很好。在我的一个应用程序中进行。）

---

我意识到这是一个非常古老的问题，但希望这会帮助其他人，因为我在这篇文章中寻找同样的东西。我有一个类似的问题，只是我的元数据是一个 Guid 和 int。解决方案是相同的。您可以将所需的元数据作为 URL 的一部分。

“控制器”类中的 POST 接受方法：

public Task<HttpResponseMessage> PostFile(string name, float latitude, float longitude)
{
    //See http://stackoverflow.com/a/10327789/431906 for how to accept a file
    return null;
}

然后，无论您要注册路由， WebApiConfig.Register(HttpConfiguration config) 在这种情况下都是我的。

config.Routes.MapHttpRoute(
    name: "FooController",
    routeTemplate: "api/{controller}/{name}/{latitude}/{longitude}",
    defaults: new { }
);

---

如果您的文件及其元数据创建了一个资源，那么在一个请求中同时上传它们是完全可以的。样品请求将是：

POST https://target.com/myresources/resourcename HTTP/1.1

Accept: application/json

Content-Type: multipart/form-data; 

boundary=-----------------------------28947758029299

Host: target.com

-------------------------------28947758029299

Content-Disposition: form-data; name="application/json"

{"markers": [
        {
            "point":new GLatLng(40.266044,-74.718479), 
            "homeTeam":"Lawrence Library",
            "awayTeam":"LUGip",
            "markerImage":"images/red.png",
            "information": "Linux users group meets second Wednesday of each month.",
            "fixture":"Wednesday 7pm",
            "capacity":"",
            "previousScore":""
        },
        {
            "point":new GLatLng(40.211600,-74.695702),
            "homeTeam":"Hamilton Library",
            "awayTeam":"LUGip HW SIG",
            "markerImage":"images/white.png",
            "information": "Linux users can meet the first Tuesday of the month to work out harward and configuration issues.",
            "fixture":"Tuesday 7pm",
            "capacity":"",
            "tv":""
        },
        {
            "point":new GLatLng(40.294535,-74.682012),
            "homeTeam":"Applebees",
            "awayTeam":"After LUPip Mtg Spot",
            "markerImage":"images/newcastle.png",
            "information": "Some of us go there after the main LUGip meeting, drink brews, and talk.",
            "fixture":"Wednesday whenever",
            "capacity":"2 to 4 pints",
            "tv":""
        },
] }

-------------------------------28947758029299

Content-Disposition: form-data; name="name"; filename="myfilename.pdf"

Content-Type: application/octet-stream

%PDF-1.4
%
2 0 obj
<</Length 57/Filter/FlateDecode>>stream
x+r
26S00SI2P0Qn
F
!i\
)%!Y0i@.k
[
endstream
endobj
4 0 obj
<</Type/Page/MediaBox[0 0 595 842]/Resources<</Font<</F1 1 0 R>>>>/Contents 2 0 R/Parent 3 0 R>>
endobj
1 0 obj
<</Type/Font/Subtype/Type1/BaseFont/Helvetica/Encoding/WinAnsiEncoding>>
endobj
3 0 obj
<</Type/Pages/Count 1/Kids[4 0 R]>>
endobj
5 0 obj
<</Type/Catalog/Pages 3 0 R>>
endobj
6 0 obj
<</Producer(iTextSharp 5.5.11 2000-2017 iText Group NV \(AGPL-version\))/CreationDate(D:20170630120636+02'00')/ModDate(D:20170630120636+02'00')>>
endobj
xref
0 7
0000000000 65535 f 
0000000250 00000 n 
0000000015 00000 n 
0000000338 00000 n 
0000000138 00000 n 
0000000389 00000 n 
0000000434 00000 n 
trailer
<</Size 7/Root 5 0 R/Info 6 0 R/ID [<c7c34272c2e618698de73f4e1a65a1b5><c7c34272c2e618698de73f4e1a65a1b5>]>>
%iText-5.5.11
startxref
597
%%EOF

-------------------------------28947758029299--

---

为了建立 ccleve 的答案，如果您使用的是 superagent / express / multer，请在前端构建您的多部分请求，执行如下操作：

superagent
    .post(url)
    .accept('application/json')
    .field('myVeryRelevantJsonData', JSON.stringify({ peep: 'Peep Peep!!!' }))
    .attach('myFile', file);

参见https://visionmedia.github.io/superagent/#multipart-requests。

在快递方面，作为 field 传递的任何内容都将在 req.body 完成后结束：

app.use(express.json({ limit: '3MB' }));

您的路线将包括以下内容：

const multerMemStorage = multer.memoryStorage();
const multerUploadToMem = multer({
  storage: multerMemStorage,
  // Also specify fileFilter, limits...
});

router.post('/myUploads',
  multerUploadToMem.single('myFile'),
  async (req, res, next) => {
    // Find back myVeryRelevantJsonData :
    logger.verbose(`Uploaded req.body=${JSON.stringify(req.body)}`);

    // If your file is text:
    const newFileText = req.file.buffer.toString();
    logger.verbose(`Uploaded text=${newFileText}`);
    return next();
  },
  ...

不过要记住的一件事是 multer 文档中关于磁盘存储的注释：

请注意， req.body 可能尚未完全填充。这取决于客户端将字段和文件传输到服务器的顺序。

我想这意味着根据文件传递的 json 元数据计算目标目录/文件名是不可靠的

---