.Net Core Swagger 给类库模型添加注解

摘要:
由于公司流程的需要,我们需要向请求和响应模型以及每个API的属性添加注释。发现Api项目所依赖的Model类库中///Sumy的注释没有影响。通过数据和实践。发现Swashbuckle.AspNetCore。可以使用注释包。

因为公司流程的需要,需要给每个API的Request 和Response 模型及属性加上注解,发现Api项目依赖的Model 类库中的/// Summy的注解并没有作用。

通过翻资料和实践。发现借助 Swashbuckle.AspNetCore.Annotations 包可以实现。

步骤:

  1. 在模型字段加上 [SwaggerSchema("UserId", ReadOnly = true)] 属性标签
  2. 在StartUp.cs 的 service 中注册 

    services.AddSwaggerGen(c =>
    {
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "Swagger API V1", Version = "v1" });
    c.SwaggerDoc("v2", new OpenApiInfo { Title = "Swagger API V2", Version = "v2" });
    var filePath = Path.Combine(System.AppContext.BaseDirectory, "Swagger.xml");
    c.IncludeXmlComments(filePath);
    c.EnableAnnotations();
    });

效果

.Net Core Swagger 给类库模型添加注解第1张

在引用这个包的时候,有部分依赖包存在版本兼容问题。

可以参考原项目:https://github.com/domaindrivendev/Swashbuckle.AspNetCore

免责声明:文章转载自《.Net Core Swagger 给类库模型添加注解》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇Mac anaconda 在terminal中fbprophet安装过程Matlab/Simulink仿真中如何将Scope转化为Figure?下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

VIP视频解析接口,送给有需要的人

VIP视频解析接口:http://api.bbbbbb.me/jx/?url=http://www.a305.org/weixin.php?url=http://api.91exp.com/svip/?url=http://api.bbbbbb.me/ipsign/player.php?v=http://api.ledboke.com/vip/?url=h...

API及接口清单

模块 应用场景 类型 API/接口 AP 付款核销 API ap_pay_invoice_pkg.ap_pay_invoice AP 应付发票审批 API ap_approval_pkg.approval AP 预付款核销 API ap_prepay_pkg.apply_prepay_fr_prepay AP 创建应付发票...

关于 RESTFUL API 安全认证方式的一些总结

常用认证方式在之前的文章REST API 安全设计指南与使用 AngularJS & NodeJS 实现基于 token 的认证应用两篇文章中,[译]web权限验证方法说明中也详细介绍,一般基于REST API 安全设计常用方式有:HTTP Basic Basic admin:admin Basic YWRtaW46YWRtaW4...

SpringBoot之springfox(Swagger) (ApiDoc接口文档)

Springfox的前身是swagger-springmvc,是一个开源的API doc框架,可以将我们的Controller的方法以文档的形式展现,基于Swagger。 官网地址:http://springfox.github.io/springfox/ 1.maven依赖 <!--springfox--> <dependency&g...

[转] Android自动测试之monkeyrunner工具(二)

monkeyrunner工具  前言: 最近开始研究Android自动化测试方法,对其中的一些工具、方法和框架做了一些简单的整理,其中包括android测试框架、CTS、Monkey、Monkeyrunner、benchmark、其它test tool等等。因接触时间很短,很多地方有不足之处,希望能和大家多多交流。   一、什么是monkeyrunner...

突袭HTML5之Javascript API扩展2 地理信息服务

      现在比较火的一类服务叫做基于位置的服务(location-based service, LBS),这一类服务就是企业利用某点(例如用户所在的位置)坐标附近的区域提供服务的信息,比如常见的地图相关服务。在HTML5中,加入了新的地理位置API用来确定和分享地理位置。 隐私申明      在与远程Web服务器共享物理位置时,隐私是一个需要关注的问题...