.net:swagger 显示所有注释

一、安装下图的两个nuget包

二、请求和返回的class都需要加上summary包裹的注释头

三、program.cs添加配置

c# 复制代码
builder.Services.AddSwaggerGen(c =>
{
    c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
    c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "swagger文档标题", Version = "v1" });
    var sss = Assembly.GetExecutingAssembly();
    var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    var xmlModelFile = "model层名称.xml";
    // 获取xml文件路径
   // var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); 
    c.CustomSchemaIds(x => x.FullName);
    c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFile), true);
    c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlModelFile), true);
    //c.IncludeXmlComments(xmlPath, true); 
});

四、接口请求头配置

c# 复制代码
  /// <summary>
  /// 接口名称
  /// </summary>
  /// <param name="参数名">注释</param>
   /// <returns></returns>
  [HttpPost]
  [AllowAnonymous] 
  [SwaggerResponse(200, "成功", typeof(返回的class名))]
  public ActionResult<返回的class名> getList([FromForm] 请求的class名 request)
  {
      return.......
  }
相关推荐
天多高_风不晓得16 分钟前
Comparable 与 Comparator
后端
程序员鱼皮19 分钟前
这 3 年 AI Agent 到底进化了啥?万字大白话,一次讲透!
前端·后端·aigc
一条Go20 分钟前
SSH 命令审核流:为什么「能执行」必须先「被批准」
后端·架构·github
__underline__30 分钟前
冷门Python知识点007篇:list[int]不是类,为什么能当基类?
后端·python
用户6152183299631 分钟前
为什么 String 是不可变的?看懂字符串常量池和底层实现
后端
brilliance1 小时前
HashMap 底层原理详解,从数组、链表到红黑树
后端
未秃头的程序猿1 小时前
RedisTemplate 序列化用错,线上多了 3 个 G 的隐形 key
redis·后端
掘金者阿豪1 小时前
MySQL兼容性实践:从SQL语法适配到业务系统平滑迁移
后端
Jeff-Tsai2 小时前
Day 25:审计轨迹与变更的前后值
.net·架构设计·erp·definition-driven
超低空2 小时前
一文说清LRU算法
后端·算法·架构