对于开发人员来说接口调试是必不可少的,对于swagger相比不会陌生接下来是在core中配置首先,先去NetGet包里去搜索Swashbuckle.AspNetCore然后点击下载
然后我们到Startup里来配置一下,在这里需要引用一下
using Microsoft.Extensions.DependencyInjection;然后我们找到ConfigureServices方法去进行配置以下代码
// 注册Swagger服务
services.AddSwaggerGen(c =>
{
// 添加文档信息
c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo {
Title = "添加标题", Version = "v1"
});
// 使用反射获取xml文件。并构造出文件的路径
string xmlFile = @"你的存放路径";
string xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
// 启用xml注释. 该方法第二个参数启用控制器的注释,默认为false.
c.IncludeXmlComments(xmlPath, true);
});
然后右键API项目->属性->生成 我们启用一下xml
然后我们再到Configure方法添加一下代码
//启用中间件服务对swagger-ui,指定Swagger JSON终结点
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
需要注意的是我们要在Properties下的launchSettings.json文件里添加一下,项目运行就会自动帮我们启动swagger页面了,没加的话只能手动在地址栏输入路径了swagger/index.html