什么是Swagger?
Swagger是一款RESTFUL接口的文档在线自动生成+功能测试的软件。
Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTFUL风格的Web服务。
详情请访问相关播客:Swagger简介
1、首先找到项目中的“依赖项”--->"管理NuGet程序包"
2、然后点开包源管理里面的设置:
3、复制如下链接,操作步骤如下:
4、然后选择这个包源,再进行搜索就有了:
5、安装完成之后,编辑Startup.cs文件。
//首先引入三个命名空间
using System.IO;
using System.Reflection;
using Swashbuckle.AspNetCore.Swagger;
//配置Swagger
//注册Swagger生成器,定义一个Swagger 文档
public void ConfigureServices(IServiceCollection services)
{
.....
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo
{
Version = "v1",
Title = "接口文档",
Description = "RESTful API"
});
// 为 Swagger 设置xml文档注释路径
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
c.IncludeXmlComments(xmlPath);
});
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
....
//启用中间件服务生成Swagger
app.UseSwagger();
//启用中间件服务生成Swagger,指定Swagger JSON根节点
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web App V1");
c.RoutePrefix = string.Empty; //设置根节点访问
});
}
详细步骤请移步相关播客:.Net Core WebApi(一) 简单创建及使用