NetCore+Dapper WebApi架构搭建（五）：Swagger构建WebApi界面

2021-07-24 06:18:02

上一节讲解了仓储的依赖注入，想必现在都可以通过构造函数依赖注入直接调用

但是WebApi只是提供一个接口调用，为了方便我们的操作，我们得给他加上一个图形化界面工具，使用Swagger

WebApi项目添加Swagger的Nuget包：Swashbuckle.AspNetCore

打开StartUp.cs类，在ConfigureServices方法里面添加下面的代码

 1 #region  添加SwaggerUI
 2 
 3             services.AddSwaggerGen(options =>
 4             {
 5                 options.SwaggerDoc("v1", new Info
 6                 {
 7                     Title = "Dinner API接口文档",
 8                     Version = "v1",
 9                     Description = "RESTful API for Dinner",
10                     TermsOfService = "None",
11                     Contact = new Contact { Name = "wangshibang", Email = "wangyulong0505@sina.com", Url = "" }
12                 });
13                 options.IgnoreObsoleteActions();
14                 options.DocInclusionPredicate((docName, description) => true);
15                 options.IncludeXmlComments(Path.Combine(PlatformServices.Default.Application.ApplicationBasePath, "Dinner.WebApi.xml"));
16                 options.DescribeAllEnumsAsStrings();
17                 options.OperationFilter<HttpHeaderOperation>(); // 添加httpHeader参数
18             });
19 
20             #endregion

在Configure方法里面添加下面的代码

1 #region 使用SwaggerUI
2 
3             app.UseSwagger();
4             app.UseSwaggerUI(options =>
5             {
6                 options.SwaggerEndpoint("/swagger/v1/swagger.json", "Dinner API V1");
7             });
8 
9             #endregion