认识Swagger
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。
作用:
1 接口的文档在线自动生成。
2 功能测试。
为什么使用Swagger作为REST APIs文档生成工具
1 Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。
2 Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
3 Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
4 Swagger 有一个强大的社区,里面有许多强悍的贡献者。
安装Nuget包搜索Swashbuckle.AspNetCore
1.创建一个Asp.NetCoreWebApi项目;
2.使用Nuget安装Swagger:
3 项目右键–》管理nuget程序包;
4 搜索Swashbuckle.AspNetCore并安装。
怎么在 startup注册,引用 Swagger
注册Swagger
//注册swaggert
services.AddSwaggerGen(m =>
{
//v1自己定义 Title项目名 Version版本 值自己定义
m.SwaggerDoc("v1", new OpenApiInfo { Title = "BBSWebServer", Version = "v1" });
});
添加Swagger 引用
//中间件引用swaggert服务
app.UseSwagger();
//v1一定要个前面注册的那个一致
app.UseSwaggerUI(M=> {
M.SwaggerEndpoint("/swagger/v1/swagger.json", "swaggerTest");
});