资讯

精准传达 • 有效沟通

从品牌网站建设到网络营销策划,从策略到执行的一站式服务

如何配置swagge和控制netcorewebapi-创新互联

本篇文章为大家展示了如何配置swagge和控制net core webapi,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。

创新互联公司长期为1000+客户提供的网站建设服务,团队从业经验10年,关注不同地域、不同群体,并针对不同对象提供差异化的产品和服务;打造开放共赢平台,与合作伙伴共同营造健康的互联网生态环境。为偃师企业提供专业的成都网站建设、成都网站制作偃师网站改版等技术服务。拥有十载丰富建站经验和众多成功案例,为您定制开发。

前言

首先希望webapi支持多版本,swagger针对不同的版本可进行交互。多版本控制基于Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer包,swagger可以选择Swashbuckle.AspNetCore和nswag.AspNetCore.由于我们系统使用的是nswag所以继续沿用,当然Swashbuckle.AspNetCore也和不错,有时间再总结。

版本控制

1.导入相关nuget。Swashbuckle.AspNetCore,nswag.AspNetCore.

2.添加api多版本控制服务

2.1.首先是让项目支持多版本的服务添加

services.AddApiVersioning(option =>
  {
   // 可选,为true时API返回支持的版本信息
   option.ReportApiVersions = true;
   // 不提供版本时,默认为1.0
   option.AssumeDefaultVersionWhenUnspecified = true;
   //版本信息放到header ,不写在不配置路由的情况下,版本信息放到response url 中
   option.ApiVersionReader = new HeaderApiVersionReader("api-version");
   // 请求中未指定版本时默认为1.0
   option.DefaultApiVersion = new ApiVersion(1, 0);
  }).AddVersionedApiExplorer(option =>
  {  // 版本名的格式:v+版本号
   option.GroupNameFormat = "'v'V";
   option.AssumeDefaultVersionWhenUnspecified = true;
  });
  ////获取webapi版本信息,用于swagger多版本支持 
  this.provider = services.BuildServiceProvider().GetRequiredService();

当前文章:如何配置swagge和控制netcorewebapi-创新互联
文章链接:http://cdkjz.cn/article/dcdcgs.html
多年建站经验

多一份参考,总有益处

联系快上网,免费获得专属《策划方案》及报价

咨询相关问题或预约面谈,可以通过以下方式与我们联系

业务热线:400-028-6601 / 大客户专线   成都:13518219792   座机:028-86922220