Swagger生成API接口注释、参数注释、实体模型注释
Swagger生成API接口注释、实体模型注释
Swagger页面预览
控制器 api 接口注释
接口参数注释
模型的注释
解决方案
生成->输出->生成包含API文档的文件
WebApi Project项目右键属性,生成->输出->生成包含API文档的文件
重要:如果要生成实体模型的API文档文件,同样在实体模型Project项目右键属性,生成->输出->生成包含API文档的文件。
C#代码
C# 全选
builder.Services.AddSwaggerGen(options =>
{
options.SwaggerDoc("v1", new OpenApiInfo
{
Version = "v1",
Title = "CSFramework.License",
Description = "软件授权系统API接口文档 \r\nCopyrights@2024 www.csframework.com"
});
//控制器接口注释
var xmlFileName = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlFilePath = Path.Combine(AppContext.BaseDirectory, xmlFileName);
options.IncludeXmlComments(xmlFilePath, true);
//实体注释
var xmlModelFileName = $"{Assembly.Load("CSFramework.LicenseServerCore").GetName().Name}.xml";
var xmlModelFilePath = Path.Combine(AppContext.BaseDirectory, xmlModelFileName);
options.IncludeXmlComments(xmlModelFilePath, true);
});
版权声明:本文为开发框架文库发布内容,转载请附上原文出处连接
NewDoc C/S框架网