如何通过 REST API 发送文件？

Question

我正在尝试通过 REST API 将文件发送到服务器。该文件可能是任何类型，但它的大小和类型可能会受到限制，可以作为电子邮件附件发送。

我认为我的方法是将文件作为二进制流发送，然后在到达服务器时将其保存回文件中。 .Net 中是否有内置方法可以执行此操作，还是我需要手动将文件内容转换为数据流并发送？

为了清楚起见，我可以控制客户端和服务器代码，因此我不限于任何特定方法。

Answer 1

1. 检测与请求一起传输的文件。
2. 决定上传文件的路径（并确保该目录存在 CHMOD 777）
3. 接受客户端连接
4. 使用现成的库进行实际上传

查看以下讨论： REST file upload with HttpRequestMessage or Stream?

Answer 2

我建议您查看 RestSharp
http://restsharp.org/

RestSharp 库具有将文件发布到 REST 服务的方法。 (RestRequst.AddFile())。我相信在服务器端，这将转换为正文中的编码字符串，标头中的内容类型指定文件类型。

我还看到它通过将流转换为 base-64 字符串并将其作为序列化 json/xml 对象的属性之一传输来完成。特别是如果您可以设置大小限制并希望在请求中将文件元数据作为同一对象的一部分包含在内，这非常有效。

这实际上取决于您的文件有多大。如果它们非常大，您需要考虑流式传输，其中的细微差别已在此 SO 帖子中进行了非常详尽的介绍：How do streaming resources fit within the RESTful paradigm?

Answer 3

您可以将其作为 POST 请求发送到服务器，将文件作为 FormParam 传递。

    @POST
        @Path("/upload")
       //@Consumes(MediaType.MULTIPART_FORM_DATA)
        @Consumes("application/x-www-form-urlencoded")
        public Response uploadFile( @FormParam("uploadFile") String script,  @HeaderParam("X-Auth-Token") String STtoken, @Context HttpHeaders hh) {

            // local variables
            String uploadFilePath = null;
            InputStream fileInputStream = new ByteArrayInputStream(script.getBytes(StandardCharsets.UTF_8));

            //System.out.println(script); //debugging

            try {
                  uploadFilePath = writeToFileServer(fileInputStream, SCRIPT_FILENAME);
            }
            catch(IOException ioe){
               ioe.printStackTrace();
            }
            return Response.ok("File successfully uploaded at " + uploadFilePath + "\n").build();
        }

 private String writeToFileServer(InputStream inputStream, String fileName) throws IOException {

        OutputStream outputStream = null;
        String qualifiedUploadFilePath = SIMULATION_RESULTS_PATH + fileName;

        try {
            outputStream = new FileOutputStream(new File(qualifiedUploadFilePath));
            int read = 0;
            byte[] bytes = new byte[1024];
            while ((read = inputStream.read(bytes)) != -1) {
                outputStream.write(bytes, 0, read);
            }
            outputStream.flush();
        }
        catch (IOException ioe) {
            ioe.printStackTrace();
        }
        finally{
            //release resource, if any
            outputStream.close();
        }
        return qualifiedUploadFilePath;
    }

Answer 4

基于@MutantNinjaCodeMonkey 对 RestSharp 的建议。我的用例是将 jquery 的 $.ajax 方法中的 webform 数据发布到 web api 控制器中。 RESTful API 服务需要将上传的文件添加到请求正文中。上面提到的AddFile的默认restsharp方法导致了The request was aborted: The request was canceled的错误。以下初始化工作：

// Stream comes from web api's HttpPostedFile.InputStream 
     (HttpContext.Current.Request.Files["fileUploadNameFromAjaxData"].InputStream)
using (var ms = new MemoryStream())
{
    fileUploadStream.CopyTo(ms);
    photoBytes = ms.ToArray();
}

var request = new RestRequest(Method.PUT)
{
    AlwaysMultipartFormData = true,
    Files = { FileParameter.Create("file", photoBytes, "file") }
};