asp.net core 2.1 生成swagger文档

新建asp.netcore2.1 api项目 “WebApplication1”

 

在nuget管理器中添加对Swashbuckle.AspNetCore 3.0.0、Microsoft.AspNetCore.StaticFiles 2.1.1 的引用

 

右键WebApplication1打开属性面板 左侧找到“生成”，把“XML文档文件”打钩  将路径修改为 “bin\Debug\netcoreapp2.1\WebApplication1.xml” （默认的路径会在项目里生成一个xml文件 这不是我们希望看到的）

 

右键WebApplication1打开属性面板 左侧找到“调试”，按照下图设置

 

在项目Properties下找到launchSettings.json文件进行修改，如下图

 

修改Startup.cs文件 内容如下

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Swashbuckle.AspNetCore.Swagger;

namespace WebApplication1
{
    public class Startup
    {
        private readonly IHostingEnvironment _hostingEnv;

        public Startup(IHostingEnvironment env, IConfiguration configuration)
        {
            _hostingEnv = env;
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info
                {
                    Title = "WebApplication1接口",
                    Version = "v1",
                    Description = ""
                });

                // 注释
                c.IncludeXmlComments($"{AppContext.BaseDirectory}{Path.DirectorySeparatorChar}{_hostingEnv.ApplicationName}.xml");

            });

            services.ConfigureSwaggerGen(option =>
            {
            });
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseHsts();
            }

            app.UseStaticFiles();

            // TODO 可以设置filter，根据权限返回对应操作API文档
            app.UseSwagger(c =>
            {
                c.PreSerializeFilters.Add((swaggerDoc, httpReq) => swaggerDoc.Host = httpReq.Host.Value);
            });

            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "WebApplication1接口V1");
            });

            app.UseHttpsRedirection();
            app.UseMvc();
        }
    }
}

 最后：启动项目就能看到swagger文档界面了

 下一步对swagger文档进行详细的配置