ASP.NET Core 2.2在Visual Studio 2017中创建 Web API并整合Swagger

ASP.NET Core 2.2在Visual Studio 2017中创建 Web API并整合Swagger

一、创建 ASP.NET Core WebApi项目

ASP.NET Core 2.2在Visual Studio 2017中创建 Web API并整合Swagger

 

ASP.NET Core 2.2在Visual Studio 2017中创建 Web API并整合Swagger

二、Nuget Packages安装Swagger包,可以通过方法1或是方法2安装

 Swashbuckle.AspNetCore

方法1:通过Nuget包管理器安装

       

ASP.NET Core 2.2在Visual Studio 2017中创建 Web API并整合Swagger

方法2: 通过程序包管理器控制台安装

安装命令:Install-Package Swashbuckle.AspNetCore -Pre

ASP.NET Core 2.2在Visual Studio 2017中创建 Web API并整合Swagger

三、注册Swagger

            //注册 Swagger
            services.AddSwaggerGen(sg =>
            {
                sg.SwaggerDoc("refuge", new Microsoft.OpenApi.Models.OpenApiInfo
                {
                    Title = "我的第一个 Swagger",
                    Version = "版本1"
                });
            });

四、配置Swagger:

            //配置 Swagger
            app.UseSwagger();
            app.UseSwaggerUI(s =>
            {
                s.SwaggerEndpoint("/swagger/refuge/swagger.json", "My API 1.0.1");//注意,中间那段的名字 (refuge) 要和 上面 SwaggerDoc 方法定义的 名字 (refuge)一样
                s.RoutePrefix = string.Empty; //默认值是 "swagger" ,需要这样请求:https://localhost:44300/
            });

编译项目,在浏览器中访问:https://localhost:44300/

ASP.NET Core 2.2在Visual Studio 2017中创建 Web API并整合Swagger