.NET Core WebAPI如何集成Swagger做接口管理
admin
2023-02-15 08:00:08
0

什么是Swagger?
Swagger 是一个规范且完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口,可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义,用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似,Swagger 消除了调用服务时可能会有的猜测。

Swagger 有什么优势?
支持 API 自动生成同步的在线文档:使用 Swagger 后可以直接通过代码生成文档,不再需要自己手动编写接口文档了,对程序员来说非常方便,可以节约写文档的时间去学习新技术。
提供 Web 页面在线测试 API:光有文档还不够,Swagger 生成的文档还支持在线测试。参数和格式都定好了,直接在界面上输入参数对应的值即可在线测试接口。

在.NET Core中如何使用Swagger?
(1)准备工作
创建一个.NET Core WebApi 项目
创建一个Model类库

(2)在项目中引入Swagger
在WebApi项目中执行命令:Install-package Swashbuckle.AspNetCore
.NET Core WebAPI如何集成Swagger做接口管理
(3)在StarUp.cs的ConfigureServices中添加代码

#region Swagger
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info
                {
                    Version = "v1.1.0",
                    Title = "Swagger WebAPI",
                    Description = "XXX项目API文档",
                    TermsOfService = "None",
                    Contact = new Swashbuckle.AspNetCore.Swagger.Contact { Name = "XXX项目", Email = "273145719@qq.com"
                    , Url = "https://www.cnblogs.com/NBIDataVis/" }
                });
                var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);
                //添加接口XML的路径
                var xmlPath = Path.Combine(basePath, "TrySwaggerCore.xml");
                //如果需要显示控制器注释只需将第二个参数设置为true
                c.IncludeXmlComments(xmlPath, true);
            });
 #endregion

(4)在StarUp.cs的Configure中添加代码

#region Swagger
app.UseSwagger();
app.UseSwaggerUI(c =>
{
  c.SwaggerEndpoint("/swagger/v1/swagger.json", "ApiDocument V1");
});
#endregion

(5)运行后进入/swagger目录 即可查看Swagger已经启用

.NET Core WebAPI如何集成Swagger做接口管理

.NET Core WebAPI如何集成Swagger做接口管理

问题汇总:
(1)如果需要将WebApi的默认启动页设为Swagger则在Properties中
.NET Core WebAPI如何集成Swagger做接口管理

(2)在这里大家会发现运行后接口的注释并没有显示,我们需要配置注释XML文件
在WebAPI项目上点击右键-》属性-》生成-》XML文档文件
.NET Core WebAPI如何集成Swagger做接口管理
另外切记此处代码第二个参数需要设置为True,否则将不显示控制器级别的注释,只显示接口注释
.NET Core WebAPI如何集成Swagger做接口管理

(3)如果大家会发现有了许多警告,强迫症患者看这里,我们只需要在生成中强制过滤1591的警告即可
.NET Core WebAPI如何集成Swagger做接口管理

相关内容

热门资讯

终于明白“泸州大贰到底有挂吗?... 有 亲,根据资深记者爆料泸州大贰是可以开挂的,确实有挂(咨询软件无需打开...
7.2亿元!郑州经开区2宗涉宅... 【大河财立方 记者 朱娟】12月25日,郑州经开区有两宗涉宅用地出让。根据成交结果,两宗地块均底价成...
涉案300亿!公安部通报打击金... 12月25日,公安部在京召开专题新闻发布会,通报公安部和国家金融监督管理总局联合部署开展金融领域“黑...
智能体落地元年,Agent I... 鹭羽 发自 凹非寺 量子位 | 公众号 QbitAI 毋庸置疑!2025年title属于「Agent...
市水保科研所召开2025年科研... 12月23日,市水保科研所组织召开2025年度科研项目年终总结推进会,全面总结年度科研工作成效,系统...
今日重大发现“秦乐陕西麻将有挂... 家人们!今天小编来为大家解答秦乐陕西麻将透视挂怎么安装这个问题咨询软件客服徽9752949的挂在哪里...
【今日要闻】“微壳字牌是不是有... 网上科普关于“微壳字牌有没有挂”话题很是火热,小编也是针对微壳字牌作*弊开挂的方法以及开挂对应的知识...
终于懂了“开心武汉花究竟有挂吗... 有 亲,根据资深记者爆料开心武汉花是可以开挂的,确实有挂(咨询软件无需打...
玩家最新攻略“皇豪众娱牛牛有没... 有 亲,根据资深记者爆料皇豪众娱牛牛是可以开挂的,确实有挂(咨询软件无需...
我来教教您“猫猫学数辅助器?”... 有 亲,根据资深记者爆料猫猫学数是可以开挂的,确实有挂(咨询软件无需打开...