webapi获取文件上传
‘壹’ 如何使 WebAPI 自动生成漂亮又实用在线API文档
1.1 SwaggerUI
SwaggerUI 是一个简单的Restful API 测试和文档工具。简单、漂亮、易用（官方demo）。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 你可以几乎放在任何Web容器上使用。
1.2 Swashbuckle
Swashbuckle 是.NET类库,可以将WebAPI所有开放的控制器方法生成对应SwaggerUI的JSON配置。再通过SwaggerUI 显示出来。类库中已经包含SwaggerUI 。所以不需要额外安装。
2.快速开始
创建项目 OnlineAPI来封装网络音乐服务(示例下载) ，通过API可以搜索、获取音乐的信息和播放连接。
我尽量删除一些我们demo中不会用到的一些文件，使其看上去比较简洁。
WebAPI 安装 Swashbuckle
Install-Package Swashbuckle
代码注释生成文档说明。
Swashbuckle 是通过生成的XML文件来读取注释的，生成 SwaggerUI，JSON 配置中的说明的。
安装时会在项目目录 App_Start 文件夹下生成一个 SwaggerConfig.cs 配置文件，用于配置 SwaggerUI 相关展示行为的。如图：
将配置文件大概99行注释去掉并修改为
c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));
并在当前类中添加一个方法
/// <summary>
/// </summary>
/// <param name="name"></param>
/// <returns></returns>
protected static string GetXmlCommentsPath(string name)
{
return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name);
}
紧接着你在此Web项目属性生成选卡中勾选 “XML 文档文件”，编译过程中生成类库的注释文件
添加网络音乐 3个API
访问 http://<youhost>/swagger/ui/index,最终显示效果
我们通过API 测试API 是否成功运行
3.添加自定义HTTP Header
在开发移动端 API时常常需要验证权限，验证参数放在Http请求头中是再好不过了。WebAPI配合过滤器验证权限即可
首先我们需要创建一个 IOperationFilter 接口的类。IOperationFilter
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http;
using System.Web.Http.Description;
using System.Web.Http.Filters;
using Swashbuckle.Swagger;
namespace OnlineAPI.Utility
{
public class HttpHeaderFilter : IOperationFilter
{
public void Apply(Operation operation, SchemaRegistry
schemaRegistry, ApiDescription apiDescription)
{
if (operation.parameters == null) operation.parameters = new
List<Parameter>();
var filterPipeline =
apiDescription.ActionDescriptor.GetFilterPipeline();
//判断是否添加权限过滤器
var isAuthorized = filterPipeline.Select(filterInfo =>
filterInfo.Instance).Any(filter => filter is IAuthorizationFilter);
//判断是否允许匿名方法
var allowAnonymous =
apiDescription.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().Any();
if (isAuthorized && !allowAnonymous)
{
operation.parameters.Add(new Parameter
{
name = "access-key",
@in = "header",
description = "用户访问Key",
required = false,
type = "string"
});
}
}
}
}
在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码
c.OperationFilter<HttpHeaderFilter>();
添加Web权限过滤器
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Web;
using System.Web.Http;
using System.Web.Http.Controllers;
using Newtonsoft.Json;
namespace OnlineAPI.Utility
{
/// <summary>
///
/// </summary>
public class AccessKeyAttribute : AuthorizeAttribute
{
/// <summary>
/// 权限验证
/// </summary>
/// <param name="actionContext"></param>
/// <returns></returns>
protected override bool IsAuthorized(HttpActionContext actionContext)
{
var request = actionContext.Request;
if (request.Headers.Contains("access-key"))
{
var accessKey = request.Headers.GetValues("access-key").SingleOrDefault();
//TODO 验证Key
return accessKey == "123456789";
}
return false;
}
/// <summary>
/// 处理未授权的请求
/// </summary>
/// <param name="actionContext"></param>
protected override void HandleUnauthorizedRequest(HttpActionContext actionContext)
{
var content = JsonConvert.SerializeObject(new {State = HttpStatusCode.Unauthorized});
actionContext.Response = new HttpResponseMessage
{
Content = new StringContent(content, Encoding.UTF8, "application/json"),
StatusCode = HttpStatusCode.Unauthorized
};
}
}
}
在你想要的ApiController 或者是 Action 添加过滤器
[AccessKey]
最终显示效果
4.显示上传文件参数
SwaggerUI 有上传文件的功能和添加自定义HTTP Header 做法类似，只是我们通过特殊的设置来标示API具有上传文件的功能
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http.Description;
using Swashbuckle.Swagger;
namespace OnlineAPI.Utility
{
/// <summary>
///
/// </summary>
public class UploadFilter : IOperationFilter
{
/// <summary>
/// 文件上传
/// </summary>
/// <param name="operation"></param>
/// <param name="schemaRegistry"></param>
/// <param name="apiDescription"></param>
public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
{
if (!string.IsNullOrWhiteSpace(operation.summary) && operation.summary.Contains("upload"))
{
operation.consumes.Add("application/form-data");
operation.parameters.Add(new Parameter
{
name = "file",
@in = "formData",
required = true,
type = "file"
});
}
}
}
}
在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码
c.OperationFilter<UploadFilter>();
API 文档展示效果
‘贰’ webapi实行文件转换调用报500错误
一般是程序运行异常了导致500，你在代码里try catch一下把错误日志打出来基本就知道问题了。webapi是运行在w3wp进程里的，所以权限与你直接运行exe时不同，有可能是权限问题导致异常
‘叁’ .NET6 WebApi快速部署到Linux系统
.NET6 WebApi快速部署到Linux系统
要将.NET6 WebApi快速部署到Linux系统，可以通过以下步骤实现。这里我们将使用宝塔面板（BT Panel）作为服务器管理工具，它提供了图形化界面，方便我们进行环境配置和项目部署。
一、安装宝塔面板
启动宝塔面板：
首先，你需要在Linux服务器上安装宝塔面板。可以通过SSH连接到你的服务器，并执行宝塔面板的安装命令。具体安装命令可以在宝塔官网找到，通常是一个包含脚本的URL，执行该URL即可开始安装。
登录宝塔面板：
安装完成后，你可以在浏览器中访问你的服务器IP地址加上宝塔面板的默认端口（通常是8888），然后输入安装时设置的用户名和密码进行登录。
二、安装.NET环境
安装.NET环境管理器：
登录宝塔面板后，在左侧菜单中找到“软件商店”，然后在“运行环境”中找到“.NET”并安装。这将安装.NET环境管理器，允许你在宝塔面板中管理多个.NET版本。
安装.NET 6：
在.NET环境管理器中，选择你需要的.NET版本（在这里是.NET 6），然后点击“安装”。宝塔面板将自动下载并安装.NET 6环境。
三、部署.NET项目
创建NET项目并上传文件：
在宝塔面板的左侧菜单中找到“网站”，然后点击“添加站点”。在添加站点的界面中，填写你的网站域名（如果没有域名，可以使用服务器IP地址）和其他相关信息，然后点击“提交”。
站点创建完成后，进入该站点的管理界面，在“文件”选项卡中，点击“上传”，然后选择你要部署的.NET6 WebApi项目的发布文件（通常是一个文件夹，包含所有编译后的文件和配置文件）。
设置.NET版本、启动命令和端口：
在站点管理界面中，找到“运行环境”选项卡，然后选择你安装的.NET版本（在这里是.NET 6）。
接着，在“启动文件”中填写你的项目启动文件（通常是dotnet命令加上你的项目dll文件的名称，例如dotnet MyApi.dll）。
最后，在“端口”中填写你想要监听的端口号（默认是80，但你可以根据需要更改）。
测试部署：
设置完成后，点击“保存”按钮。然后，在站点管理界面的“访问”选项卡中，你可以看到你的网站访问链接。点击该链接，如果一切正常，你应该能够看到你的.NET6 WebApi项目已经成功部署并运行。
通过以上步骤，你就可以将.NET6 WebApi项目快速部署到Linux系统上了。如果你遇到任何问题，可以查阅宝塔面板的官方文档或社区论坛，那里有许多经验丰富的用户可以帮助你解决问题。
‘肆’ app更新机制文件如何管理
1、首先在服务端（Server）部署一个WebAPI。
2、其次在指定目录下存放一个更新包。
3、最后接收APP发送的动态更新请求，所述动态更新请求中包括所述APP的当前安装包的版本号即可。
‘伍’ 2018年10月微信小程序上传文件的问题webapi方式
必须在微信公众平台填写请求，下载，上传，websocket 域名，必须是SSL加密的