上一期写的使用Visual Studio工具,利用AI进行webapi创建和部署。 今天继续写如何采用Swagger在网页中浏览api的接口。
1. 写中文注释,AI自动生成Swagger启用代码
如下,写注释 “//启用Swagger和Swagger UI ” , AI会辅助生成代码,直接敲“Tab”键执行写入。
如果不能自动生成代码,查看FittenCode的启用状态,VS菜单中【工具】->【选项】,找到FittenCode,启用。如何安装FittenCode,请参见我之前的博文。
2.写中文注释,AI自动为Swagger的启用/关闭,添加一个配置。
打开appsettings.json文件,写个逗号,后面自动提示配置的添加代码,按Tab键写入代码。
修改一下配置字段:
"ConnectionStrings": {
"SwaggerEnabled": true
}
回到Program.cs文件,书写注释“获取配置SwaggerEnabled”,AI自动提示获取配置的代码,按Tab键写入。
修改一下配置字段。配置文件中有多个层级(例如 "ConnectionStrings": { "SwaggerEnabled": true }
),需要使用正确的路径来获取配置值,例如 builder.Configuration.GetValue<bool>("ConnectionStrings:SwaggerEnabled")
。
//启用Swagger和Swagger UI
//获取配置SwaggerEnabled
bool swaggerEnabled = builder.Configuration.GetValue<bool>("ConnectionStrings:SwaggerEnabled");
if (swaggerEnabled)
{
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
}
3.文件夹方式发布
4. 启动并访问发布后的程序
双击CoreWebAPI.exe程序启动。