首页 > 其他分享 >Abp框架使用Swgger注释加分组

Abp框架使用Swgger注释加分组

时间:2022-11-21 20:58:48浏览次数:33  
标签:WebApi Swgger SwaggerEndpoint Abp 分组 new SwaggerDoc swagger options

1.在ConfigureSwaggerServices中配置SwaggerDoc,并options.DocInclusionPredicate((doc, desc) => { return doc == desc.GroupName; });这句话可以删除也可以改成这样去写

private static void ConfigureSwaggerServices(ServiceConfigurationContext context, IConfiguration configuration) { context.Services.AddSwaggerGen(options => { options.SwaggerDoc("v1", new OpenApiInfo { Title = "MH业务.WebApi", Version = "v1" }); options.SwaggerDoc("v2", new OpenApiInfo { Title = "WGG业务.WebApi", Version = "v2" }); options.SwaggerDoc("v3", new OpenApiInfo { Title = "WJB业务.WebApi", Version = "v3" }); options.SwaggerDoc("v4", new OpenApiInfo { Title = "ZRN业务.WebApi", Version = "v4" }); options.SwaggerDoc("v5", new OpenApiInfo { Title = "LHY业务.WebApi", Version = "v5" }); options.SwaggerDoc("v6", new OpenApiInfo { Title = "公共业务.WebApi", Version = "v6" }); options.DocInclusionPredicate((doc, desc) => { return doc == desc.GroupName; }); //开启权限小锁 options.OperationFilter<AddResponseHeadersFilter>(); options.OperationFilter<AppendAuthorizeToSummaryOperationFilter>(); options.OperationFilter<SecurityRequirementsOperationFilter>(); //在header中添加token,传递到后台 options.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme { Description = "JWT授权(数据将在请求头中进行传递)直接在下面框中输入Bearer {token}(注意两者之间是一个空格) \"", Name = "Authorization",//jwt默认的参数名称 In = ParameterLocation.Header,//jwt默认存放Authorization信息的位置(请求头中) Type = SecuritySchemeType.ApiKey });
          //注意 Abp要在Application的属性中开启XML文件
          var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录(绝对,不受工作目录影响,建议采用此方法获取路径) 
          var xmlPath = Path.Combine(basePath, "TMSLogistics.Application.xml"); // 添加 swagger xml 注释 这个xml文件开始是不存在的写上项目名.xml即可
          options.IncludeXmlComments(xmlPath, true); }); }
 2.在管道中添加 SwaggerEndpoint

       app.UseSwagger(); app.UseAbpSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "MH业务.WebApi"); c.SwaggerEndpoint("/swagger/v2/swagger.json", "WGG业务.WebApi API"); c.SwaggerEndpoint("/swagger/v3/swagger.json", "WJB业务.WebApi API"); c.SwaggerEndpoint("/swagger/v4/swagger.json", "ZRN业务.WebApi API"); c.SwaggerEndpoint("/swagger/v5/swagger.json", "LHY业务.WebApi API"); c.SwaggerEndpoint("/swagger/v6/swagger.json", " 公共业务.WebApi"); });

3.引入using Microsoft.AspNetCore.Mvc;命名空间,在服务层添加 [ApiExplorerSettings(GroupName = "v1")]

 

 4.服务层打开XML注释

 

标签:WebApi,Swgger,SwaggerEndpoint,Abp,分组,new,SwaggerDoc,swagger,options
From: https://www.cnblogs.com/LaoMa0109/p/16913162.html

相关文章

  • 温故而知新——常见类&正则&分组&工具类&各种时间类
    拼图游戏(JFrame等等)x轴是竖轴y是横轴事件:1.鼠标事件2.获取键盘对应的值:美化界面的:将一维数组放到二维数组中(很妙):核心逻辑:移动图片常用的API(不需要......
  • ABP.Core+EF 左连接查询
    EF的Join查询,一般默认是内连接,但是有些情况会需要左连接,则需要如下方式://左连接varquery=fromrinthis.Repository.GetAll()        ......
  • python list dict util (分割,分组)
     1.list数据分割为多个小列表 (java  lists.partition)2.分组     importitertoolsdefpartition(mylist,size):""":parammylist:需要分......
  • ABP+EF 修改指定字段
    1、修改全部字段varvInfo=this.Repository.Get(input.Id);MapToEntity(input,vInfo);awaitthis.Repository.UpdateAsync(vInfo); 以上方法是修改全部,但是会导致......
  • k8s源码分析3-kubectl命令行设置7大命令分组
    本节重点总结:设置cmd工厂函数f,主要是封装了与kube-apiserver交互客户端用cmd工厂函数f创建7大分组命令,如下基础初级命令BasicCommands(Beginner):基础中级命......
  • 46.通过字典和Series对象进行分组统计
     -----------------------------------------------------------------------------------------------------------------------------------------------------------......
  • 45.自定义函数实现分组统计
    #自定义函数实现分组统计#能过自定义的函数实现分组统计importpandasaspddf=pd.read_excel('电脑配件销售记录.xlsx')#print(df.head()))#回顾知识点#p......
  • 44.对一列或多列使用聚合函数 (分组后使用函数计算)
     -----------------------------------------------------------------------------------------------------------------------------------------------------------......
  • 43.分组组据的迭代
     -----------------------------------------------------------------------------------------------------------------------------------------------------------......
  • 42.数据分组计算
     -----------------------------------------------------------------------------------------------------------------------------------------------------------......