Net Core2.1 WebAPI新增时髦的插件详解

说明

时髦的是一个网络应用程序接口在线注解、调试插件，过去我们主要通过手工撰写网络应用程序接口接口的交互文档供前端开发人员或外部开发者，

官网地址：https://英镑。io/。

但是在实际工作中，往往咋们的文档工作通常落后于实际的环境，导致文档和实际接口不一致，前后端开发人员苦不堪言。

时髦的的出现解放了接口文档撰写的麻烦也提高了前后端开发者的工作效率，所谓"工欲善其事，必先利其器"。现在让咋们

了解下在。网络核心2.1下如何实现霸气十足。

1、努得到安装依赖包

首先框架安装Swashbuckle .AspNetCore

打开框架控制台（程序包管理控制台),键入下列命令

安装-包装Swashbuckle .AspNetCore2、添加时髦的中间件

公共IServiceProvider ConfigureServices(IServiceCollection services){ services .configurecookiespolicy选项(选项={//此希腊字母的第11个确定给定请求是否需要用户同意非必需的饼干.选项checkconsentneedd=context=true；选项minimumsesitepolicy=SameSiteMode .无；});服务AddMvc().AddJsonOptions(选项={ //忽略循环引用选项序列化程序设置。referenceloop处理.忽略；//不使用驼峰样式的关键选项序列化程序设置。contract resolver=new default contract resolver()；}) .SetCompatibilityVersion(兼容性版本.版本_ 2 _ 1)；//注册斯瓦格生成器，定义一个或多个斯瓦格文档服务. AddSwaggerGen(c={ c . SwaggerDoc(' v1 '，新信息{ Title='My API '，Version=' v1 ' })；});returnregistereautofac(服务);//注册Autofac }引用Swashbuckle .霸气，并启用中间件

公共空配置(IApplicationBuilder应用程序，ihostingenvirmentenv){ if(env .IsDevelopment()) { app .usedeveloper异常页()；} //使中间件能够将生成的时髦的作为数据端点服务应用程序.useswaggle()；//启用中间件服务网页界面等。),//指定斯瓦格数据端点应用程序.UseSwaggerUI(c={ c . SwaggerEndpoint('/swag/v1/swag。JSON '，'我的API V1 ')；});应用程序.UseVisitLogger()；应用程序.UseMvc()；}3、配置网络应用程序接口项目属性

1、双击性能下的launchSettings.json，将launchUrl更新为时髦的

F5结果如下：

4、新增注解

如上图，虽然网络应用程序接口已经出来了，但是呢，并没有发现我们在行动上写的注释？老司机应该知道在结构版本里我们需要

将网络应用程序接口启动项属性里更改"项目生产"一栏中新增可扩展置标语言文档，磊科也是如此。如下图：

保存后，按F5发现并木有生产注解，为什么？那是因为我们必须明确告诉时髦的应该从哪个路径读取网络应用程序接口注解可扩展置标语言文件，更新启动下的配置服务。

参考下面代码：

//注册斯瓦格生成器，定义一个或多个斯瓦格文档服务AddSwaggerGen(选项={ options .SwaggerDoc('v1 '，新信息{ Title='TestSystem '，Version=' v1 ' })；//注入网络应用程序接口注释文件给斯瓦格变量xmlPath=路径。组合(AppContext .BaseDirectory，' AirWebAPI。XML ')；选项includexml注释(XMlpath)；选项IgnoreObsoleteActions()；////选项ignoreobsoletecontroller()；////类、方法标记[过时],可以阻止【霸气十足文档】生成选项descriptibellenumasstrings()；选项OperationFilterFormDataOperationFilter()；});代码不单单新增了注解，同时添加了阻止时髦的文档生成的配置，通过读取系统的[过时]特性实现。

现在，让我们再看看结果吧~

是不是很爽~~

还有斯瓦格是支持授权登录的哦，这个待研究。

总结

以上就是本文的全部内容。希望本文的内容对大家的学习或工作有一定的参考价值。有问题可以留言交流。谢谢你的支持。