1、搭建 Asp.Net Core 3.1项目,过程省略。
2、nuget包安装Swashbuckle.AspNetCore,也可通过指令安装:Install-Package Swashbuckle.AspNetCore -Version 5.3.3,如下图是nuget安装。
3、打开Startup.cs,引入using Microsoft.OpenApi.Models。
1)、将 Swagger 生成器添加到 Startup.ConfigureServices 方法中的服务集合中:
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});
2)、在 Startup.Configure 方法中,启用中间件为生成的 JSON 文档和 Swagger UI 提供服务:
app.UseSwagger();
app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); });
结果如下图:
4、运行项目,输入http://localhost:{port}/swagger/index.html。如下图所示:
5、API 信息和说明
传递给 AddSwaggerGen 方法的配置操作会添加诸如作者、许可证和说明的信息: