在Asp.netCore接口开发过程中,接口可视化工具Swagger提供了可视化API界面,可以很方便地查看接口状态和返回结果,大大方便了前端开发和测试人员使用和测试,省去再次编写API文档。
这里总结Asp.netCore接口项目中添加整合Swagger的经验。
一、创建项目打开开发工具VisualStudio,选择名为“ASP.NETCoreWebAPI”的项目模板,创建一个WebAPI接口项目。
二、搜索安装Swagger包引用在新创建的项目中,右键“依赖项”,选择“管理Nuget程序包”,打开“Nuget包管理器”界面。
搜索添加Swagger包引用"Swashbuckle.AspNetCore"
三、添加Swagger配置代码安装添加完“Swagger”包之后,在项目的“Startup.cs”文件中添加Swagger的启动配置代码,如下图中的配置所示。
再修改下图“launchSettings.json”文件中的“launchUrl”参数为“swagger”,这样启动时候,就会启动swagger的index.html页面了。
四、添加“Properties”属性配置双击项目中“Properties”,在“生成”选项界面里,添加取消显示警告级别“”,减少警告信息,勾选“XML文档文件”,Build时,会自动创建一个XML文件,这个文件是自定义接口描述信息用的。
五、配置成功运行最后,配置完成,按F5运行一下项目,就可以打开Swaggerindex.html页面,在页面上就可以看到项目中的所有接口信息了。使用起来很方便,在网页上可以查看接口状态和返回结果。