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

简介: 文章来源于阿里云 MVP郭联钰。

0、前言

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


一、准备




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


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


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


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


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



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



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


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



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



二、开始部署




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


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




然后在ConfigureServices写上服务注册

Configure方法 写上服务注册。



ConsulApp方法:


注册服务 RegisterService



至此,consul注册已经OK。

2、配置swagger具体内容


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


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

ConfigureServices方法总填写如下:


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


Configure 方法中填写以下内容:


至此,swagger配置完成。

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


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


然后在 ConfigureServices方法中写上

然后在Configure 方法中写上:

路由表里面写的内容为:

自此配置完成。

1、先运行consul



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


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

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


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

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

参考网址:

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

文章转载自阿里云 MVP郭联钰,查看原文

目录
相关文章
|
开发框架 .NET API
Windows Forms应用程序中集成一个ASP.NET API服务
Windows Forms应用程序中集成一个ASP.NET API服务
533 9
|
开发框架 监控 前端开发
在 ASP.NET Core Web API 中使用操作筛选器统一处理通用操作
【9月更文挑战第27天】操作筛选器是ASP.NET Core MVC和Web API中的一种过滤器,可在操作方法执行前后运行代码,适用于日志记录、性能监控和验证等场景。通过实现`IActionFilter`接口的`OnActionExecuting`和`OnActionExecuted`方法,可以统一处理日志、验证及异常。创建并注册自定义筛选器类,能提升代码的可维护性和复用性。
411 3
|
JSON API 数据格式
【Azure API 管理】是否可以将Swagger 的API定义导入导Azure API Management中
【Azure API 管理】是否可以将Swagger 的API定义导入导Azure API Management中
233 0
|
存储 开发框架 .NET
ASP.NET Web Api 使用 EF 6,DateTime 字段如何取数据库服务器当前时间
ASP.NET Web Api 使用 EF 6,DateTime 字段如何取数据库服务器当前时间
384 0
|
开发框架 .NET API
如何在 ASP.NET Core Web Api 项目中应用 NLog 写日志?
如何在 ASP.NET Core Web Api 项目中应用 NLog 写日志?
982 0
|
开发框架 .NET API
分享一个 ASP.NET Web Api 上传和读取 Excel的方案
分享一个 ASP.NET Web Api 上传和读取 Excel的方案
635 0
|
开发框架 中间件 .NET
分享 ASP.NET Core Web Api 中间件获取 Request Body 两个方法
分享 ASP.NET Core Web Api 中间件获取 Request Body 两个方法
1089 0
|
开发框架 前端开发 .NET
ASP.NET CORE 3.1 MVC“指定的网络名不再可用\企图在不存在的网络连接上进行操作”的问题解决过程
ASP.NET CORE 3.1 MVC“指定的网络名不再可用\企图在不存在的网络连接上进行操作”的问题解决过程
1032 0
|
存储 开发框架 前端开发
[回馈]ASP.NET Core MVC开发实战之商城系统(五)
经过一段时间的准备,新的一期【ASP.NET Core MVC开发实战之商城系统】已经开始,在之前的文章中,讲解了商城系统的整体功能设计,页面布局设计,环境搭建,系统配置,及首页【商品类型,banner条,友情链接,降价促销,新品爆款】,商品列表页面,商品详情等功能的开发,今天继续讲解购物车功能开发,仅供学习分享使用,如有不足之处,还请指正。
643 0
|
开发框架 前端开发 JavaScript
ASP.NET MVC 教程
ASP.NET 是一个使用 HTML、CSS、JavaScript 和服务器脚本创建网页和网站的开发框架。
534 7