首先我创建一个。net core项目,我使用的工具是vs2019
这里需要注意的是,看情况选择是否开启身份验证,一般是没有需求的,这里因为我是测试使用所以需要取消勾兑为https配置,并且我没有启用docker支持,因为这个
项目我只是写接口,所以我创建的是一个webapi项目
点击创建,生成项目
因为要使用swagger,所以我们需要安装指定的组件包,现在我们使用nuget安装组件
安装后我们需要去startup中进行配置
首先我们在ConfigureServices中尽心注册swagger服务
//注册swagger服务 services.AddSwaggerGen(c => { // 添加文档信息 c.SwaggerDoc("v1", new Info { Title = "CoreWebApi", Version = "v1" }); });
然后我们在Configure中启用swagger中间件
// 启用Swagger中间件 app.UseSwagger(); // 配置SwaggerUI app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "CoreWebApi"); c.RoutePrefix = string.Empty; });
接着配置的xml文件
接着我们运行我们的项目
已经看到我们已经出现了swagger的界面,那么我们尝试一下调用
忽然发现我们这个上面并没有每个接口的备注,这是咋回事那?看来我们还需要配置一些东西
我们接着去ConfigureServices中配置
再次运行项目查看
如我们所愿,备注都已经出来了
到此这篇关于.NET Core项目使用swagger开发组件的文章就介绍到这了。希望对大家的学习有所帮助,也希望大家多多支持。