Возврат потока файла, используя SwashBuckle - PullRequest
Новая
       7

Возврат потока файла, используя SwashBuckle

0 голосов
/ 10 мая 2018

Я хочу вернуть поток файлов, используя SwashBuckle 

    [System.Web.Http.HttpGet]
    [System.Web.Http.Route("Files/{uid}/file")]
    [SwaggerResponse(HttpStatusCode.OK, Type = typeof(Byte[]))]
    public HttpResponseMessage DownloadFile(String uid, String fileName)
    {
        return Safe.Execute(() =>
        {
            var api = new FileApi();
            var stream = api.GetFile(uid, fileName);

            HttpResponseMessage result = new HttpResponseMessage(HttpStatusCode.OK);
            result.Content = new StreamContent(stream);
            result.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
            result.Content.Headers.ContentDisposition =
                     new ContentDispositionHeaderValue("attachment")
                     {
                         FileName = CalcFileName(fileName)
                     };
            return result;
        });
    }

И я вижу, что файл возвращается, но ... как-то ... закодирован. Файл длиной 3798 становится 5789 байт после загрузки через пользовательский интерфейс, и содержимое файла очень похоже на ожидаемое, но включены дополнительные байты, как если бы он интерпретировался как строка и стал версией в кодировке UTF-8.

Ничего не меняется, когда я заменяю его как: 

    [SwaggerResponse(HttpStatusCode.OK, Type = typeof(Stream))]

Сгенерированный Swagger дескриптор выглядит как: 

        "produces": [    
          "application/json",    
          "text/json",    
          "application/xml",    
          "text/xml"    
        ],    
        ...
        "responses": {    
          "200": {    
            "description": "OK",    
            "schema": {    
              "format": "byte",    
              "type": "string"
        }

Есть идеи, как реализовать возврат потока файлов из метода контроллера?

1 Ответ

0 голосов
/ 11 мая 2018

Чтобы описать метод API, вы можете использовать IOperationFilter в своей конфигурации swagger 

public class UpdateFileDownloadOperations : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry s, ApiDescription a)
    {
        if (operation.operationId == "DownloadFile_Get")
        {
            operation.produces = new[] { "application/octet-stream" };
        }
    }
}

Если вы никогда не использовали фильтры, посмотрите на страницу проекта: https://github.com/domaindrivendev/Swashbuckle/blob/e0053e1864defa3c4f73ca2a960eb876e257cc9e/Swashbuckle.Dummy.Core/App_Start/SwaggerConfig.cs


В примере моего комментария я использую Swagger-Net очень похожий, но я внес некоторые улучшения, и, вероятно, вы заметили, что он использует последний Swagger-UI

...