.NET CORE 集成 swagger

1.vs版本2017--工具--NuGet包管理器--管理解决方案得NuGet程序包

5101539-378d978b7843b619_看图王.png

2.搜索Swashbuckle.AspNetCore--选择需要安装的项目--选择稳定版，点击安装

QQ截图20190730155756.png

3.Startup.cs的ConfigureServices方法中添加

        services.AddSwaggerGen(c =>
        {
            c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
        });

4.Startup.cs的Configure方法中添加

        app.UseSwagger();
      
        app.UseSwaggerUI(c =>
        {
            c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
        });

5.启动项目，在浏览器中输入http://localhost:port/swagger/

image.png

6.使用Swagger为API文档增加说明信息,在AddSwaggerGen方法中配置说明信息

services.AddSwaggerGen(c =>
        {
            c.SwaggerDoc("v1", new Info
            {
                Version = "v1",
                Title = "第一印象 API",
                Description = "A simple example ASP.NET Core Web API",
                TermsOfService = "None",
                Contact = new Contact
                {
                    Name = "第一印象",
                    Email = string.Empty,
                    Url = "http://www.topimage.design/"
                }
            });
        });

image.png

7.为文档添加注释 在项目上右键--属性--生成

image.png

8.在AddSwaggerGen方法中添加

// 为 Swagger JSON and UI设置xml文档注释路径
            var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录（绝对，不受工作目录影响，建议采用此方法获取路径）
            var xmlPath = Path.Combine(basePath, "SwaggerDemo.xml");
            c.IncludeXmlComments(xmlPath);

image.png

9.重新生成并启动项目

image.png

10.测试接口

image.png image.png image.png