AspNet Core Api Restful +Swagger 发布IIS

上一步我们创建好CoreApi

接下来在框架中加入 Swagger 并发布到 IIS

（1）首先点击依赖项》管理Nuget包

（2）输入 Swashbuckle.aspnetCore 比如：

图中两个Swagger 插件需要我们安装注意：我这里已经安装过显示的是卸载

（3）在框架中添加Swagger 注解的帮助类 HttpHeaderOperation 下面是我完整的.CS文件

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;


//添加引用
using Swashbuckle.AspNetCore.Swagger;
using Swashbuckle.AspNetCore.SwaggerGen;
using Microsoft.AspNetCore.Authorization;
namespace WebCoreApi
{
    public class HttpHeaderOperation : IOperationFilter
    {
        /// <summary>
        /// 实现接口
        /// </summary>
        /// <param name="operation"></param>
        /// <param name="context"></param>
        public void Apply(Operation operation, OperationFilterContext context)
        {
            if (operation.Parameters == null)
            {
                operation.Parameters = new List<IParameter>();
            }

            var actionAttrs = context.ApiDescription.ActionAttributes();

            var isAuthorized = actionAttrs.Any(a => a.GetType() == typeof(AuthorizeAttribute));

            if (isAuthorized == false) //提供action都没有权限特性标记，检查控制器有没有
            {
                var controllerAttrs = context.ApiDescription.ControllerAttributes();

                isAuthorized = controllerAttrs.Any(a => a.GetType() == typeof(AuthorizeAttribute));
            }

            var isAllowAnonymous = actionAttrs.Any(a => a.GetType() == typeof(AllowAnonymousAttribute));

            if (isAuthorized && isAllowAnonymous == false)
            {
                operation.Parameters.Add(new NonBodyParameter()
                {
                    Name = "Authorization",  //添加Authorization头部参数
                    In = "header",
                    Type = "string",
                    Required = false
                });
            }
        }
    }
}

（4）添加 Swagger 的·服务方法在 Startup中的 ConfigureServices方法里

public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc();
            services.AddSwaggerGen(x =>
            {
                x.SwaggerDoc("v1", new Info
                {
                    Version = "v1", //版本号
                    Title = "Szl接口文档", //标题
                    Description = "RESTful API ",
                    TermsOfService = "",//服务的条件
                    //第一个参数Name 创建人名称/也可以是 负责人名称     第二个参数 联系邮箱
                    Contact = new Contact { Name = "Su", Email = "szl_0000@126.com", Url = "北京" }
                });

                //获取设置配置信息的 的路径对象   swagger界面配置
                var basePath = PlatformServices.Default.Application.ApplicationBasePath;
                var xmlPath = Path.Combine(basePath, "AspNetCoreApiSwagger.xml");
                x.IncludeXmlComments(xmlPath);
                x.OperationFilter<HttpHeaderOperation>(); // 添加httpHeader参数
            });
        }

（5）添加 Swagger 启动项在 Startup中的 Configure方法里

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseMvc();
            app.UseSwagger();
            // 指定站点
            app.UseSwaggerUI(x =>
            {
                //做出一个限制信息 描述
                x.SwaggerEndpoint("/swagger/v1/swagger.json", "TwBusManagement API V1");
                //显示在发出请求时发送的标题
                x.ShowRequestHeaders();

            });
        }

（6）在框架自动生成的 Api 控制器里Post的方法上加入注解（其他方法也可以，我只是举例）

        /// <summary>
        /// AspNet Core  Post请求
        /// </summary>
        /// <param name="value">User类</param>
        /// <remarks>
        ///访问参数
        ///     POST 
        ///     {  
        ///        "value": "0e7ad584-7788-4ab1-95a6-ca0a5b444cbb",  
        ///     }  
        ///   
        /// </remarks> 
        /// <response code="201">返回新创建项</response>
        /// <response code="400">如果为空时</response> 

        [HttpPost]
        [ProducesResponseType(typeof(User), 201)]
        [ProducesResponseType(typeof(User), 400)]
        public void Post([FromBody]User value)
        {
        }

注解的含义如下

summary 用来描述方法的作用

remarks 用来描述传入的参数格式/也可以把调用的值放入里面

response 定义两个返回状态

User 类

/// <summary>
    /// 用户类
    /// </summary>
    public class User
    {
        /// <summary>
        /// 用户ID
        /// </summary>
        public int UserID { get; set; }
        /// <summary>
        /// 用户名称
        /// </summary>
        public int UserName { get; set; }
        /// <summary>
        /// 用户年龄
        /// </summary>
        public int UserAge { get; set; }
    }

（7）在框架中添加 AspNetCoreApiSwagger.xml 文件一定要注意的是 xml 文件必须定义一个根节点不然会报错，XML的属性改为始终复制（XML文件在第四步骤中有用到）

（8）设置项目的生成输出路径

（9）发布以文件夹发布就行

（10）部署IIS 说一下注意点改成无托管代码

（11）打开IIS服务中的模块

（12）查看是否有 AspNetCoreModule 没有进行安装我是在国外的网站下载的

（13）如果在运行部署的API 发生了错误

我们在 Program 中加入如代码所示可以帮助我们准确定义的问题所在

    public class Program
    {
        public static void Main(string[] args)
        {
            BuildWebHost(args).Run();
        }

        public static IWebHost BuildWebHost(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
      //发布程序出现错误帮助定位详细错误信息
      // .UseKestrel()
      //.UseContentRoot(Directory.GetCurrentDirectory())
      //.UseSetting("detailedErrors", "true")
      //.UseIISIntegration()

      .CaptureStartupErrors(true)
                .UseStartup<Startup>()
                .Build();



    }