当前位置:首页 > 服务端 > Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口

2022年11月06日 13:37:59服务端11

0、前言


 整体架构目录:ASP.NET Core分布式项目实战-目录

一、准备


 前提需要下载安装consul,项目需要懂添加swagger

统一在网关中配置多个微服务的swagger,需要用到服务注册和发现,当然ocelot里面以及拥有了服务发现,因此需要把asp.net core项目先注册到consul中。

楼主的项目是用到consul。下面的案例的我都是放在window系统上面弄的,正式环境需要把项目都部署到自己的服务器上面。

1、讲解:什么叫服务注册和发现

微服务的框架体系中,服务发现是不能不提的一个模块。我相信了解或者熟悉微服务的童鞋应该都知道它的重要性。这里我只是简单的提一下,毕竟这不是我们的重点。我们看下面的一幅图片:

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

图中,客户端的一个接口,需要调用服务A-N。客户端必须要知道所有服务的网络位置的,以往的做法是配置是配置文件中,或者有些配置在数据库中。这里就带出几个问题:
  需要配置N个服务的网络位置,加大配置的复杂性
  服务的网络位置变化,都需要改变每个调用者的配置
  集群的情况下,难以做负载(反向代理的方式除外)


总结起来一句话:服务多了,配置很麻烦,问题多多

既然有这些问题,那么服务发现就是解决这些问题的。话说,怎么解决呢?我们再看一张图

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

与之前一张不同的是,加了个服务发现模块。图比较简单,这边文字描述下。服务A-N把当前自己的网络位置注册到服务发现模块(这里注册的意思就是告诉),服务发现就以K-V的方式记录下,K一般是服务名,V就是IP:PORT。服务发现模块定时的轮询查看这些服务能不能访问的了(这就是健康检查)。客户端在调用服务A-N的时候,就跑去服务发现模块问下它们的网络位置,然后再调用它们的服务。这样的方式是不是就可以解决上面的问题了呢?客户端完全不需要记录这些服务网络位置,客户端和服务端完全解耦!
这个过程大体是这样,当然服务发现模块没这么简单。里面包含的东西还很多。这样表述只是方便理解。
图中的服务发现模块基本上就是微服务架构中服务发现的作用了。

 

二、开始部署


首先先创建一个asp.net core web api 项目,我已经创建好了。然后添加nugut包 consul。

1、在项目里面的 Startup.cs  文件里面写上我们的服务注册,我把注册的信息放在了appsetting.json 文件里头了。

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

 

然后在ConfigureServices写上服务注册

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

 

Configure方法 写上服务注册。

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

 

ConsulApp方法:

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

 

注册服务 RegisterService

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

 

至此,consul注册已经OK。

 

2、配置swagger具体内容

我把swagger的微服务信息放在appsetting.json 里面了。

 Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

所以在startup.cs中的数据是从这里面获取的

 

ConfigureServices方法总填写如下:

其中里面的【】中的内容是可以替换的。

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

Configure 方法中填写以下内容:

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

 

至此,swagger配置完成。

 

3、接下来就要部署Ocelot网关里面的内容啦。

apigateway项目也是创建一个asp.net core web api 项目,然后添加swaggernuget包。

然后在 ConfigureServices方法中写上

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

 

然后在Configure 方法中写上:

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

 

路由表里面写的内容为:

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

 

 自此配置完成。

 

三、运行


 1、先运行consul

 Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

打开浏览器url地址:consul运行成功。

 Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

 

 2、运行userapi项目和apigateway项目。

在consul中发现多了一个userapi的服务注册

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

 

 然后打开apigateway的swagger项目,可以看到userapi的接口,至此完成配置。

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

 

 具体swagger怎么配置,可以参考我之前的文章(努力编写中)

 

参考网址:

http://www.cnblogs.com/focus-lei/p/9047410.html


 

 

asp.net core 交流群:787464275 欢迎加群交流
如果您认为这篇文章还不错或者有所收获,您可以点击右下角的【推荐】按钮精神支持,因为这种支持是我继续写作,分享的最大动力!

作者:LouieGuo
声明:原创博客请在转载时保留原文链接或者在文章开头加上本人博客地址,如发现错误,欢迎批评指正。凡是转载于本人的文章,不能设置打赏功能,如有特殊需求请与本人联系!

微信公众号:欢迎关注                                                 QQ技术交流群: 欢迎加群

Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记                Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口 _ JavaClub全栈架构师技术笔记

作者:LouieGuo
来源链接:https://www.cnblogs.com/guolianyu/p/9557225.html

版权声明:
1、JavaClub(https://www.javaclub.cn)以学习交流为目的,由作者投稿、网友推荐和小编整理收藏优秀的IT技术及相关内容,包括但不限于文字、图片、音频、视频、软件、程序等,其均来自互联网,本站不享有版权,版权归原作者所有。

2、本站提供的内容仅用于个人学习、研究或欣赏,以及其他非商业性或非盈利性用途,但同时应遵守著作权法及其他相关法律的规定,不得侵犯相关权利人及本网站的合法权利。
3、本网站内容原作者如不愿意在本网站刊登内容,请及时通知本站(javaclubcn@163.com),我们将第一时间核实后及时予以删除。


本文链接:https://www.javaclub.cn/server/68166.html

分享给朋友:

“Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口” 的相关文章

深入理解分布式、微服务中CAP定律和BASE理论

深入理解分布式、微服务中CAP定律和BASE理论

一、背景 随着互联网的快速蔓延,各种传统项目(单体应用的架构)已经不能够满足当前各种复杂的需求场景,都逐渐向分布式服务、微服务做转换,而如今分布式、微服务架构已经普遍存在互联网公司的项目中,像大型电商网站等几乎都是分布式、微服务架构的。因此分布式和...

springboot成神之——swagger文档自动生成工具

springboot成神之——swagger文档自动生成工具

本文讲解如何在spring-boot中使用swagger文档自动生成工具 目录结构 说明 依赖 SwaggerConfig 开启api界面 JSR 303注释信息 Swagger核...

.net core在Ocelot网关中统一配置Swagger

.net core在Ocelot网关中统一配置Swagger

最近在做微服务的时候,由于我们是采用前后端分离来开发的,提供给前端的直接是Swagger,如果Swagger分布在各个API中,前端查看Swagger的时候非常不便,因此,我们试着将Swagger集中放到网关中。 这里我用两个API项目(一个BasicDataApi,一个User...

Swagger-UI展示接口

Swagger-UI展示接口

简单介绍API的管理工具Swagger的UI模块。 简介:swagger ui就是一个能整合到项目中让api的注释能够生成到一个网页上。能简单测试和给前端看。 第一步:添加引用 打开NuGet程序包管理器,搜索Swagger。安装搜索出来的这个Swashbuckle。...

Swagger使用

Swagger使用

原文:https://www.cnblogs.com/liruiloveparents/p/9378327.html     Swagger学习及生成HTML文档 Swagger 1、集成springboot 第一步:pom...

Swagger结合mustache模板生成后台接口代码、以及前后台建模代码

Swagger结合mustache模板生成后台接口代码、以及前后台建模代码

之前项目中使用的的thrift来建模,维护前后台模型以及rest接口,前台使用的是angular2;  但是使用thrift只能生成建模,后台的rest接口的Controller文件还是需要手动去写,一旦接口改动就会涉及到很多方面。 由此准备使用Swagger和m...

关于Swagger优化

关于Swagger优化

背景   尽管.net6已经发布很久了,但是公司的项目由于种种原因依旧基于.net Framework。伴随着版本迭代,后端的api接口不断增多,每次在联调的时候,前端开发叫苦不迭:“小胖,你们的swagger页面越来越卡了,快优化优化!”。 先查看swagger页面加载耗时:...

springmvc+swagger构建Restful风格文档

springmvc+swagger构建Restful风格文档

  本次和大家分享的是java方面的springmvc来构建的webapi接口+swagger文档;上篇文章分享.net的webapi用swagger来构建文档,因为有朋友问了为啥.net有docpage文档你还用swagger,这里主要目的是让接口文档统一,当操作多种开发语言做接口时...

在SpringBoot中Swagger配置及使用

在SpringBoot中Swagger配置及使用

Swagger号称世界上最流行的Api框架,它是RestFul 风格的Api。文档在线自动生成工具:Api文档与API定义同步更新。可以直接运行,能在线测试API接口;支持多种编程语言:(Java、PHP等)。 官网:https://swagger.io/ 在项目中使用Sw...

使用swagger 生成 Flask RESTful API

使用swagger 生成 Flask RESTful API

什么是REST REST(英文:Representational State Transfer,又称具象状态传输)是Roy Thomas Fielding博士于2000年在他的博士论文 中提出来的一种万维网软件架构风格,目的是便于不同软件/程序在网络(例如互联网)中互相传递信息。...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。