百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

「编程」NetCore学习之Swagger netcore学习

yuyutoo 2024-10-12 01:50 2 浏览 0 评论

在学习net core中接触到了swagger、学习并记录

纯API项目中 引入swagger可以生成可视化的API接口页面


引入包

nuget包: Swashbuckle.AspNetCore(最新稳定版)

配置

1.配置Startup类ConfigureServices方法的相关配置

//配置Startup类ConfigureServices方法的相关配置
1 public void ConfigureServices(IServiceCollection services)
 2         {
 3             //swagger服务配置
 4             services.AddSwaggerGen(c =>
 5             {
 6                 c.SwaggerDoc("V1", new Microsoft.OpenApi.Models.OpenApiInfo
 7                 {
 8                     Version = "v1",//接口文档版本
 9                     Title = "我的接口文档1.0",//接口文档标题
10                     Description = "我的第一个swagger文档",//接口文档描述
11                     Contact = new Microsoft.OpenApi.Models.OpenApiContact { Name = "张华", Url = new Uri("http://baidu.com"), Email = "nice0320@163.com" },
12                     License = new Microsoft.OpenApi.Models.OpenApiLicense { Name = "张华", Url = new Uri("http://baidu.com") }
13                 });
14             });
15             services.AddControllers();
16         }

2.配置Startup类Configure方法的中间件

//配置Startup类Configure方法的中间件
1 public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
 2         {
 3             if (env.IsDevelopment())
 4             {
 5                 app.UseDeveloperExceptionPage();
 6             }
 7 
 8             app.UseRouting();
 9 
10             app.UseAuthorization();
11 
12             app.UseEndpoints(endpoints =>
13             {
14                 endpoints.MapControllers();
15             });
16 
17             ///swagger中间件启动配置
18             app.UseSwagger();
19             app.UseSwaggerUI(a => {
20                 a.SwaggerEndpoint("/swagger/V1/swagger.json", "中间件启动配置,我的第一个swagger文档");
21                 //如果是为空 访问路径就为 根域名/index.html,注意localhost:8001/swagger是访问不到的
22                 //路径配置,设置为空,表示直接在根域名(localhost:8001)访问该文件
23                 // c.RoutePrefix = "swagger"; // 如果你想换一个路径,直接写名字即可,比如直接写c.RoutePrefix = "swagger"; 则访问路径为 根域名/swagger/index.html
24                 a.RoutePrefix = string.Empty;//路由
25             });
26         }

2.配置Startup类Configure方法的中间件

注意:

新建项目第一次配置完成运行的时候可能如下所示。因为 /WeatherForecast 是官方默认的地址

解决方案:Properties文件夹下launchSettings.json文件launchUrl属性改为null

launchUrl代表浏览器里启动相对的URL


4-14更新:



虽然配置好了swagger,但是众多接口也不好分辨,因此我们需要给接口添加注释

1,右键项目属性-生成-输出(将文档文件勾选,路径可默认可以自己设置)

2,在 Startup.cs文件ConfigureServices方法配置服务(上面配置swagger的地方)

 public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            //配置swagger
            services.AddSwaggerGen(a =>
            {
                a.SwaggerDoc("CoreOne_Zhang", new Microsoft.OpenApi.Models.OpenApiInfo
                {
                    Version = "第一版",
                    Title = "CoreOne_Zhang的Swagger第一版",
                    Description = "专有",
                    Contact = new Microsoft.OpenApi.Models.OpenApiContact
                    {
                        Email = "nicezh0320@163.com",
                        Url = new Uri("https://jq.qq.com/?_wv=1027&k=GecDlZAd"),
                        Name = "张华"
                    }
                });
               //xml文档路径
                var basePath = AppContext.BaseDirectory;
         //将路径和文件拼接
                var xmlPath = Path.Combine(basePath, "NetCore.OneApi.xml");
         //将xml文档注入。true表示是否显示控制器注释,默认false
                a.IncludeXmlComments(xmlPath,true);
            });

2022:4-20更新:Swagger多版本操作

可以将不同的接口分别展示

接上文。设置好swagger后,我们需要设置多个版本(页面?)

1,可以先创建一个版本类。(枚举类型)

2,将原本固定写死的版本号,利用 版本类 循环输出

typeof循环在SwaggerDoc之外。

 services.AddSwaggerGen(s =>
            {
                typeof(SwaggerType).GetEnumNames().ToList().ForEach(version =>
                {
                    s.SwaggerDoc(version, new OpenApiInfo
                    {
                        Version = version,
                        Title = "欢迎一起学习",
                        Description = "多版本自定义API",
                        Contact = new OpenApiContact { Name = "张华", Url = new Uri("https://jq.qq.com/?_wv=1027&k=mwVO65PG") },
                        License = new OpenApiLicense { Name = "张华", Url = new Uri("https://jq.qq.com/?_wv=1027&k=mwVO65PG") }
                    });
                    var path = System.AppDomain.CurrentDomain.BaseDirectory;
                    var xmlPath = System.IO.Path.Combine(path, "NetNotes.xml");
                    s.IncludeXmlComments(xmlPath, true);
                });
            });

同理,中间件也需要配置循环一下,只要将SwaggerEndpoint,RoutePrefix外面循环 版本输出即可

app.UseSwagger();
            app.UseSwaggerUI(a =>
            {
                typeof(SwaggerType).GetEnumNames().ToList().ForEach(V =>
                {
                    a.SwaggerEndpoint(#34;swagger/{V}/swagger.json", #34;版本{V}");
                    a.RoutePrefix = "";
                });
            });

3,将不同的接口展示在不同的版本页面

只需要加[ApiExplorerSettings(GroupName ="Zhang")] Zhang可以替换成你 版本 类里面的任何一个,那么他就只显示在你规定的版本页面当中

运行效果:

//效果显示地址:Swagger UI

//一起学习,Git克隆地址:NetCore学习: NetCore学习 Master:swagger Jwt:Jwt身份验证登录 (gitee.com)

Ps:欢迎一起学习

相关推荐

野路子科技!2步教你把手机改造成一个FTP服务器,支持PC互传

哈喽,大家好,我是野路子科技,今天来给大家带来一个教程,希望大家喜欢。正如标题所言,就是教大家如何把售价改造成FTP服务器,而这个时候估计有朋友会问了,把手机改造成FTP服务器有什么用呢?现在有Q...

不得不看:别样于Server-U的群晖文件存储服务器的搭建与使用

我先前的作品中,有着关于Server-U的ftp文件存储服务器的搭建与访问的头条文章和西瓜视频,而且我们通过各种方式也给各位粉丝介绍了如何突破局域网实现真正意义上的公网访问机制技术。关于Server-...

Qt三种方式实现FTP上传功能_qt引入qftp库

FTP协议FTP的中文名称是“文件传输协议”,是FileTransferProtocol三个英文单词的缩写。FTP协议是TCP/IP协议组中的协议之一,其传输效率非常高,在网络上传输大的文件时,经...

Filezilla文件服务器搭建及客户端的使用

FileZilla是一个免费开源的FTP软件,分为客户端版本和服务器版本,具备所有的FTP软件功能。可控性、有条理的界面和管理多站点的简化方式使得Filezilla客户端版成为一个方便高效的FTP客户...

美能达柯美/震旦复印机FTP扫描怎么设置?

好多网友不知道怎么安装美能达/震旦复印机扫描,用得最多是SMB和FTP扫描,相对于SMB来说,FTP扫描安装步骤更为便捷,不容易出问题,不需要设置文件夹共享,所以小编推荐FTP来扫描以美能达机器为例详...

CCD(简易FTP服务器软件)_简单ftp服务器软件

CCD简易FTP服务器软件是一款很方便的FPT搭建工具,可以将我们的电脑快速变成一个FPT服务器。使用方法非常简单,只要运行软件就会自动生效,下载银行有该资源。该工具是不提供操作界面的,其他用户可以输...

Ubuntu系统搭建FTP服务器教程_ubuntu架设服务器

在Ubuntu系统上搭建FTP服务器是文件传输的一个非常实用方法,适合需要进行大量文件交换的场景。以下是一步步指导,帮助您在Ubuntu上成功搭建FTP服务器。1.安装vsftpd软件...

理光FTP扫描设置教程_理光ftp扫描设置方法

此教程主要用来解决WIN10系统下不能使用SMB文件夹扫描的问题,由于旧的SMB协议存在安全漏洞,所以微软在新的系统,WIN8/WIN10/SERVER201220162018里使用了新的SMB传...

纯小白如何利用wireshark学习网络技术

写在前面工欲善其事必先利其器!熟悉掌握一种神器对以后的工作必然是有帮助的,下面我将从简单的描述Wireshark的使用和自己思考去写,若有错误或不足还请批评指正。...

京东买13盘位32GB内存NAS:NAS系统安装设置教程

本内容来源于@什么值得买APP,观点仅代表作者本人|作者:yasden你没有看错,我在京东自营商城购买硬件,组装了一台13盘位,32GB内存的NAS,硬盘有13个盘位!CPU是AMD的5500!本文...

FileZilla搭建FTP服务器图解教程_filezilla server搭建ftp服务器

...

python教程之FTP相关操作_python ftps

ftplib类库常用相关操作importftplibftp=ftplib.FTP()ftp.set_debuglevel(2)#打开调试级别2,显示详细信息ftp.connect(“I...

xftp怎么用,xftp怎么用,具体使用方法

Xftp是一款界面化的ftp传输工具,用起来方便简单,这里为大家分享下Xftp怎么使用?希望能帮到有需要的朋友。IIS7服务器管理工具可以批量管理、定时上传下载、同步操作、数据备份、到期提醒、自动更新...

树莓派文件上传和下载,详细步骤设置FTP服务器

在本指南中,详细记录了如何在树莓Pi上设置FTP。设置FTP可以在网络上轻松地将文件传输到Pi上。FTP是文件传输协议的缩写,只是一种通过网络在两个设备之间传输文件的方法。还有一种额外的方法,你可以用...

win10电脑操作系统,怎么设置FTP?windows10系统设置FTP操作方法

打印,打印,扫描的日常操作是每一个办公工作人员的必需专业技能,要应用FTP作用扫描文件到电脑上,最先要必须一台可以接受文件的FTP服务器。许多软件都需要收费标准进行,但人们还可以应用Windows的系...

取消回复欢迎 发表评论: