Swagger一个优秀的Api接口文档生成工具。Swagger可以可以动态生成Api接口文档,有效的降低前后端人员关于Api接口的沟通成本,促进项目高效开发。

1、使用NuGet安装最新的包:Swashbuckle.AspNetCore。

.NetCore学习笔记:六、Swagger API接口文档工具_第1张图片

 2、编辑项目文件(NetCoreTemplate.Web.csproj),配置

.NetCore学习笔记:六、Swagger API接口文档工具_第2张图片

  bin\Debug\netcoreapp3.1\NetCoreTemplate.Web. bin\Debug\netcoreapp3.1\   bin\Release\netcoreapp3.1\NetCoreTemplate.Web. bin\Release\netcoreapp3.1\ 

3、在项目中注册Swagger,添加一个文档信息和导入

// 注册Swagger服务services.AddSwaggerGen(c =>{ // 添加文档信息 c.SwaggerDoc("v1", new OpenApiInfo { Title = "NetCoreTemplate Api", Version = "v1" }); //导入

4、添加Swagger中间件和Page UI。

app.UseSwagger();app.UseSwaggerUI(c =>{ c.SwaggerEndpoint("/swagger/v1/swagger.json", "NetCoreTemplate V1");});

这样配置就完成了,启动程序检验一下成果。

.NetCore学习笔记:六、Swagger API接口文档工具_第3张图片

 

 

源码地址:https://github.com/letnet/NetCoreDemo

 

.NetCore学习笔记:六、Swagger API接口文档工具
文章转载:http://www.shaoqun.com/a/463718.html