【.net core 5.0】创建系统默认WebApi

前提条件：

　　1、Visual Studio 2019 16.8 或更高版本

       2、NET 5.0 SDK 或更高版本

A、新建项目--WebApi，默认系统会勾选Enable OpenAPI Support

 

 

 B、创建完成后直接运行，就可以看到带Swagger的文档说明及调用界面了

 

 

C、添加XML注释，让方法名的注释也能显示在文档中

　　1、在“解决方案资源管理器”中右键单击该项目，然后选择“编辑 <project_name>.csproj”，在代码中添加

　　

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
  <NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>

        如下图：

　　

 

 

 

　　2、在ConfigureServices的services.AddSwaggerGen代码中添加如下代码：

var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
c.IncludeXmlComments(xmlPath);

　　如下图：

　　

 

 　　3、在对应的Controller方法上，添加Summary注释，然后再次运行项目就可以看到了

　　

 

 

 

 

关于更多配置可参考官网：

Swigger详情配置：https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-5.0&tabs=visual-studio

理由配置：https://docs.microsoft.com/zh-cn/aspnet/core/mvc/controllers/routing?view=aspnetcore-5.0#attribute-routing-with-httpverb-attributes

依赖注入到视图：https://docs.microsoft.com/zh-cn/aspnet/core/mvc/views/dependency-injection?view=aspnetcore-5.0

依赖注入到控制器：https://docs.microsoft.com/zh-cn/aspnet/core/mvc/controllers/dependency-injection?view=aspnetcore-5.0

 

单元测试控制逻辑：https://docs.microsoft.com/zh-cn/aspnet/core/mvc/controllers/testing?view=aspnetcore-5.0

identityserver4：https://docs.identityserver.io/en/latest/index.html