KPI考核系统实战之二:swagger框架
- 一、asp.net core 3.1
- 二、融合swagger
- 1.Nuget安装Swashbuckle.AspNetCore
- 2.Startup.cs 注册Swagger服务,使用swagger中间件
一、asp.net core 3.1
使用Visual Studio 2022,搭建asp.net core weiapi开发平台,此平台也可以加入html运行。
二、融合swagger
1.Nuget安装Swashbuckle.AspNetCore
实践发现,上面两个包都要安装,需要注意的是第一个没用,一开始因为安装了这个找了好久原因,终于发现是包不对。
2.Startup.cs 注册Swagger服务,使用swagger中间件
//Register the Swagger generator, defining 1 or more Swagger documents 注册Swagger生成器,定义由Swagger生成器创建的一个或多个文档
services.AddSwaggerGen(s =>
{
//定义由Swagger生成器创建的一个或多个文档
s.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo()
{
Title = "Swagger测试",
Description = "这是一个swagger测试接口",
Version = "v1",
TermsOfService = new Uri("https://test.com"), // A URL to the Terms of Service for the API. MUST be in the format of a URL. API服务条款的URL
Contact = new Microsoft.OpenApi.Models.OpenApiContact()
{
Email = "shanshanyouwen@126.com",
Name = "shanshanyouwen"
},
License = new Microsoft.OpenApi.Models.OpenApiLicense()
{
Name = "SwaggerLicense",
Url = new Uri("https://test.com")
}
});
});
// Enable middleware to serve generated Swagger as a JSON endpoint. 允许中间件将生成的Swagger用作JSON端点。
// Register the Swagger middleware with optional setup action for DI-injected options 使用DI注入选项的可选设置操作注册Swagger中间件
app.UseSwagger();
//Register the SwaggerUI middleware with optional setup action for DI-injected 为注入的DI注册带有可选设置操作的SwaggerUI中间件
//Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.) 使中间件能够为swagger ui(HTML、JS、CSS等)提供服务
app.UseSwaggerUI();