平台WebAPI文件上传、下载（OrBitWebAPI2） - .Net 平台应用与技巧

# 1、概述
为支持WebUI上传、下载文件，在原有OrBitWebAPI2接口的基础上新增文件上传、下载接口，详细说明如下：
WCF更新包（其中，dll文件放到WCF的bin目录下）
[【附件】UploadApi.rar](/media/attachment/2024/07/UploadApi.rar)

# 2、步骤
2.1 获取加密票（支持GET、POST）。可选（WCF可配置关闭，建议开启）
2.2 上传文件（只支持POST，form-data方式）
2.3 下载文件

# 3、OrBitWebAPI2
### 3.1 获取加密票
与OrBitWebAPI2完全一致
![](/media//202311/2023-11-20_113651.png)

### 3.2 上传文件
LoadFile 参数值为 upload，标识下载文件（只支持POST，form-data方式）
![](/media//202311/2023-11-20_114937.png)

【客户端调用】示例
```csharp
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("http://121.37.203.18/OrBitWCFMOM_Dev_R16/OrBitWebAPI2.ashx"),
    Content = new MultipartFormDataContent
    {
        new StringContent("JSON")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "OutType",
                }
            }
        },
        new StringContent("UPLOAD")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "LoadFile",
                }
            }
        },
        new StringContent("")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "API",
                }
            }
        },
        new StringContent("{\n\"userName\": \"HG0064\",\n\"pluginName\": \"FTP15\",\n\"objPKId\": \"\"\n}")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "UserParameter",
                }
            }
        },
        new StringContent("34A28908009144C9AAD3314C98106B7C84C59D6CD1EE57D7F16822401A999DFB20ED70E5D8B8080DAA3C877E53AEE40D50EECEEA7F9B11AAF80FA3C2D3E8FF6D1E8CE16901E79E03B111FD39331551B5B4862C97756078A1D3917DF98B54807E")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "UserTicket",
                }
            }
        },
        new StringContent(["E:\\image\\response.txt","E:\\image\\test1.png","E:\\image\\test2.png","E:\\image\\test3.png","E:\\image\\test4.png","E:\\image\\test5.png","E:\\image\\test6.png"])
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "Files",
                    FileName = "E:\image\response.txt,E:\image\test1.png,E:\image\test2.png,E:\image\test3.png,E:\image\test4.png,E:\image\test5.png,E:\image\test6.png",
                }
            }
        },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}
```

### 3.3 下载文件
LoadFile 参数值为 download，标识下载文件
![](/media//202311/2023-11-20_114658.png)

【客户端调用】示例
```csharp
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("http://121.37.203.18/OrBitWCFMOM_Dev_R16/OrBitWebAPI2.ashx"),
    Content = new MultipartFormDataContent
    {
        new StringContent("JSON")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "OutType",
                }
            }
        },
        new StringContent("download")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "LoadFile",
                }
            }
        },
        new StringContent(" {\"ftpFileId\": \"FTP1000002M5\"}")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "UserParameter",
                }
            }
        },
        new StringContent("34A28908009144C9BD58F90CDAE946EC8572DD9E087E58864272C8BCD8E381F6C8B22A47040B41B0E48709F619ECE2218C025B89594529F2299BE740BE9017EAE1EEA2D0E01F8ECBA741BDC0E8644148EE658743C2249531E2E2A6A62FC470E1")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "UserTicket",
                }
            }
        },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}
```
# 4、内置接口
4.1 WebAPI_GetFtpSetting 	获取FTP参数配置
```sql
EXEC dbo.WebAPI_GetFtpSetting
    @OrBitUserName = N''    -- nvarchar(100)
  , @ResourceName = N''     -- nvarchar(100)
  , @UserParameter = N'{"pluginName": "FTP15"}'    -- nvarchar(max)
  , @UserData = N''         -- nvarchar(max)

```
4.2 WebAPI_FtpUpload	保存文件上传记录
```sql
EXEC dbo.WebAPI_FtpUpload
    @OrBitUserName = N''    -- nvarchar(100)
  , @ResourceName = N''     -- nvarchar(100)
  , @UserParameter = N'
{
      "SQLDataSet": [
        {
          "FtpFileName": "FtpFileName",
          "FtpDirectory": "FtpDirectory",
          "FtpFileDescription": "FtpFileDescription",
          "FtpFileSize": "FtpFileSize",
          "PluginCommand": "PluginCommand",
          "UploadUser": "UploadUser",
          "UploadComputer": "UploadComputer",
          "PKId": "PKId"
        }
      ]
    }
'    -- nvarchar(max)
  , @UserData = N''         -- nvarchar(max)

```
4.3 GetFtpFileByFtpId	获取FTP文件信息
```sql
EXEC dbo.WebAPI_GetFtpFileByFtpId
    @OrBitUserName = N''    -- nvarchar(100)
  , @ResourceName = N''     -- nvarchar(100)
  , @UserParameter = N'{"ftpFileId": "FTP1000002NH"}'    -- nvarchar(max)
  , @UserData = N''         -- nvarchar(max)
```

![](/media//202311/2023-11-28_111453.png)