<div class="post">
<h1 class="postTitle">
<a id="cb_post_title_url" class="postTitle2" href="https://www.cnblogs.com/guolianyu/p/9557225.html">Ocelot网关统一查看多个微服务asp.net core项目的swagger API接口</a>
</h1>
<div class="clear"></div>
<div class="postBody">
<div id="cnblogs_post_body" class="blogpost-body ">
<h1><span style="color: #3194d0;">0、前言</span></h1>
<p> 整体架构目录:<a id="cb_post_title_url" class="postTitle2" href="https://www.cnblogs.com/guolianyu/p/9473676.html" target="_blank">ASP.NET Core分布式项目实战-目录</a></p>
<h1><span style="color: #3194d0;">一、准备</span></h1>
<p> <strong>前提需要下载安装consul,项目需要懂添加swagger</strong></p>
<p>统一在网关中配置多个微服务的swagger,需要用到服务注册和发现,当然ocelot里面以及拥有了服务发现,因此需要把asp.net core项目先注册到consul中。</p>
<p>楼主的项目是用到consul。下面的案例的我都是放在window系统上面弄的,正式环境需要把项目都部署到自己的服务器上面。</p>
<h3>1、讲解:什么叫服务注册和发现</h3>
<p>微服务的框架体系中,服务发现是不能不提的一个模块。我相信了解或者熟悉微服务的童鞋应该都知道它的重要性。这里我只是简单的提一下,毕竟这不是我们的重点。我们看下面的一幅图片:</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830112427862-1046625971.png" alt=""></p>
<p>图中,客户端的一个接口,需要调用服务A-N。客户端必须要知道所有服务的网络位置的,以往的做法是配置是配置文件中,或者有些配置在数据库中。这里就带出几个问题:
需要配置N个服务的网络位置,加大配置的复杂性
服务的网络位置变化,都需要改变每个调用者的配置
集群的情况下,难以做负载(反向代理的方式除外)</p>
<p>
总结起来一句话:服务多了,配置很麻烦,问题多多</p>
<p>既然有这些问题,那么服务发现就是解决这些问题的。话说,怎么解决呢?我们再看一张图</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830112514071-1973285074.png" alt=""></p>
<p>与之前一张不同的是,加了个服务发现模块。图比较简单,这边文字描述下。服务A-N把当前自己的网络位置注册到服务发现模块(这里注册的意思就是告诉),服务发现就以K-V的方式记录下,K一般是服务名,V就是IP:PORT。服务发现模块定时的轮询查看这些服务能不能访问的了(这就是健康检查)。客户端在调用服务A-N的时候,就跑去服务发现模块问下它们的网络位置,然后再调用它们的服务。这样的方式是不是就可以解决上面的问题了呢?客户端完全不需要记录这些服务网络位置,客户端和服务端完全解耦!
这个过程大体是这样,当然服务发现模块没这么简单。里面包含的东西还很多。这样表述只是方便理解。
图中的服务发现模块基本上就是微服务架构中服务发现的作用了。</p>
<p> </p>
<h1><span style="color: #3194d0;">二、开始部署</span></h1>
<p>首先先创建一个asp.net core web api 项目,我已经创建好了。然后添加nugut包 consul。</p>
<h3>1、在项目里面的 Startup.cs 文件里面写上我们的服务注册,我把注册的信息放在了appsetting.json 文件里头了。</h3>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830115744356-1263458759.png" alt=""></p>
<p> </p>
<p>然后在ConfigureServices写上服务注册</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830142138354-733680577.png" alt=""></p>
<p> </p>
<p>Configure方法 写上服务注册。</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830142158926-1722820507.png" alt=""></p>
<p> </p>
<p>ConsulApp方法:</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830142228057-62071936.png" alt=""></p>
<p> </p>
<p>注册服务 RegisterService</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830142258926-1195267833.png" alt=""></p>
<p> </p>
<p>至此,consul注册已经OK。</p>
<p> </p>
<h3>2、配置swagger具体内容</h3>
<p>我把swagger的微服务信息放在appsetting.json 里面了。</p>
<p> <img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830143208748-846465283.png" alt=""></p>
<p>所以在startup.cs中的数据是从这里面获取的</p>
<p> </p>
<p>ConfigureServices方法总填写如下:</p>
<p>其中里面的【】中的内容是可以替换的。</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830143943233-1869550020.png" alt=""></p>
<p>Configure 方法中填写以下内容:</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830143446528-668114988.png" alt=""></p>
<p> </p>
<p>至此,swagger配置完成。</p>
<p> </p>
<h3>3、接下来就要部署Ocelot网关里面的内容啦。</h3>
<p>apigateway项目也是创建一个asp.net core web api 项目,然后添加swaggernuget包。</p>
<p>然后在 ConfigureServices方法中写上</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830144741607-2135245684.png" alt=""></p>
<p> </p>
<p>然后在Configure 方法中写上:</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830144904775-477287552.png" alt=""></p>
<p> </p>
<p>路由表里面写的内容为:</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830144559470-190277685.png" alt=""></p>
<p> </p>
<p> 自此配置完成。</p>
<p> </p>
<h1><span style="color: #3194d0;">三、运行</span></h1>
<h3> 1、先运行consul</h3>
<p> <img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830145005214-203186268.png" alt=""></p>
<p>打开浏览器url地址:consul运行成功。</p>
<p> <img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830145033435-367778062.png" alt=""></p>
<p> </p>
<h3> 2、运行userapi项目和apigateway项目。</h3>
<p>在consul中发现多了一个userapi的服务注册</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830145132813-84209495.png" alt=""></p>
<p> </p>
<p> 然后打开apigateway的swagger项目,可以看到userapi的接口,至此完成配置。</p>
<p><img src="https://images2018.cnblogs.com/blog/651008/201808/651008-20180830145227933-356222594.png" alt=""></p>
<p> </p>
<h3> 具体swagger怎么配置,可以参考我之前的文章(努力编写中)</h3>
<p> </p>
<h3><span style="color: #3194d0;">参考网址:</span></h3>
<p>http://www.cnblogs.com/focus-lei/p/9047410.html</p>