![overlord](https://i-blog.csdnimg.cn/blog_migrate/28b3c07c9c5f7277aef45a00b964d1ef.png)
overlord
昨天,我简要介绍了霸王项目家族。 今天是时候进行试驾了。 API管理子项目两天前发布了1.0.0.Alpha1,并根据18个月的路线图介绍了第一组功能。
APIMan到底是什么?
它是一个API管理系统,可以嵌入现有框架或应用程序中,甚至可以作为单独的系统运行。 到现在为止还挺好。 但是什么是API管理?为什么要关心它? 事实是,当今的应用程序规模越来越大,复杂性越来越高,并且分布越来越广泛。 将更多的消费者添加到移动设备,电视或即将推出的整个IoT设备等组合中,并考虑如何在整个应用程序中一致地实施访问控制或使用。 一个噩梦的候选人。 但是不要太担心。 这就是API管理的用武之地。APIMan为您的API提供了基于策略的灵活的运行时治理。 它允许API提供者通过多种计划提供相同的API,从而为不同的API使用者提供不同级别的服务。 听起来还复杂吗? 试一试吧。
图书馆REST服务
想象一下,公共图书馆有一个不错的RESTful服务,其中列出了书籍。 它在某个地方运行,通常实际上并不受访问限制。 现在,有人想到了构建一个出色的移动应用程序的想法,该应用程序可以确定图书是否在图书馆中。 下一步应该是添加一个选项来预订一本书几个小时,这是旧系统目前无法做到的。 我们将不使用大量的库应用程序的旧版本,而是使用APIMan为移动应用程序提供一致的API,并让它现在管理身份验证。 我在这里使用的API是一个简单的resteasy示例。 您可以使用必须使用的任何Web服务终结点。
WildFly 8.1入门
该项目可以在各种运行时平台上构建和部署,但是如果您希望尽快看到它在运行,则只需要派生并克隆APIMan GitHub存储库,并简单地使用Maven 3.x进行构建即可。 如果使用“ run-all-wildfly8”配置文件,则可以立即对其进行测试,因为它不仅可以构建项目,还可以下载并配置最新的WildFly 8.1,并最终为您启动它。 构建并启动需要花费一些时间,因此最好带点耐心。
因此,要做的所有探索就是在http:// localhost:8080 / apiman-dt-ui /上启动管理控制台,并使用以下用户之一登录(“!”是密码,btw):
- admin / admin123!
- bwayne / bwayne123!
- ckent / ckent123!
- dprince / dprince123!
试驾快速入门
该文档现在有点薄弱,所以我将向您简要介绍一下控制台。
打开控制台并使用admin用户登录。 现在,您可以“创建一个新的组织”,现在将其称为“公共图书馆”。 新创建的组织向您显示一些选项卡(“应用程序”,“服务”,“计划”,“成员”)。 切换到服务选项卡,然后单击“新服务”按钮。 输入“ BookListing”作为名称,将1.0保留为“版本”,您可能会对其进行描述,以供参考。
单击“创建服务”按钮后,您将重定向到概述页面。 切换到“实施”并填写最终的API端点。 在我的情况下,这将是:http:// localhost:9080 / jaxb-json / resteasy / library / books / badger(注意:它部署在另一个WildFly实例上)完成后单击“保存”。 如果切换回概述页面,您会看到该服务处于“已创建”状态,并且“发布”按钮仍显示为灰色。 为了实现此目标,我们需要向APIMan添加更多信息。 下一步是向组织添加一个所谓的计划。 切换回它并选择“计划”选项卡,然后单击“新计划”按钮。 计划基本上允许对单个策略进行分组并将其分配给服务。 将其称为“ InternetBlackList”,然后单击相应的按钮来创建它。 从“计划”概述中,通过单击按钮选择“策略”和“添加策略”。 定义“ IP黑名单策略”,然后输入您不希望访问该服务的潜在恶意IP地址。为了能够发布我们的服务,我们需要将新创建的计划链接到BookListing服务。 导航回到那里,然后选择“计划”选项卡。 选择“ InternetBlackList”计划,然后单击“保存”。 现在,查看服务上的“概述”页面最终将显示“就绪”状态,让我们进行发布。
现在已经发布了,我们可以实际使用它了。 但是我们将在此处采取另一步骤,并通过合同将服务链接到应用程序。 通过创建合同,您可以通过服务提供的特定计划将应用程序连接到服务。 您可能希望这样做,以便您的应用程序可以成功调用服务。
通过导航回公共图书馆组织并单击“新建应用程序”按钮来创建应用程序。 将其命名为“慕尼黑”,保留1.0的版本,并根据需要输入说明; 点击“创建应用程序”。 剩下要做的第一步是链接服务和应用程序。 这是通过合同完成的。 选择“合同”页面,然后使用按钮创建“新合同”。 在“查找服务”字段中输入“ book”,然后搜索我们的BookListing服务。 选择它。 现在您可以创建合同。
最后一步是在“概述”页面中注册新创建的应用程序。
就是这样我们现在有一个已发布的服务和一个注册的应用程序。 如果导航到应用程序的API页面,则可以看到该应用程序的托管端点。 如果将鼠标悬停在该服务上,则会出现一个“复制”按钮,该按钮可让您复制通过APIMan网关传递的托管端点的URL。
如果您尝试通过指定的列入黑名单的IP地址访问该服务,现在将收到错误消息。 如果没有,您将通过网关代理到该服务。
注意apikey查询字符串吗? 这是网关用来定位服务并代理对受管端点的呼叫的密钥。 如果您不想将其作为查询字符串的一部分发送,则还可以使用称为X-API-Key的自定义HTTP标头。下一步是什么?
那是一个非常快速且不完整的过程。 但是希望您对它背后的基本概念有所了解。 APIMan和其他Overlord子项目发展Swift。 他们很高兴收到您的贡献,如果您喜欢自己所看到的内容或收到其他反馈,请随时与该项目联系。 如果您想了解更多类似于API的方法,则还可以观看和收听以下截屏视频。 这有些过时了,但仍然很有帮助。
翻译自: https://www.javacodegeeks.com/2014/09/api-management-in-wildfly-8-1-with-overlord.html
overlord