# AECORE统一网关使用手册

2020-09-04

联系人:廖波涛(liaobt@glodon.com),刘卓(liuz-l@glodon.com)

本文将快速引导您如何在API网关中,发布后端服务的API,并使用postman调用。

# 概述

您需要依次完成以下步骤:

  • 创建环境

  • 创建并定义API

  • 绑定scope

  • 发布API

  • 调用API

# 创建环境

环境是API的管理单元,因此需要先创建环境,然后创建API上传至环境中。当前支持设置多种环境,目的是能够满足不同您的不同研发场景下的API 调用需求,如API测试环境,后端服务对应到您的测试环境资源,从而可以保证在同一套API配置的情况下,供您的测试人员进行测试使用。

步骤一:创建环境

在SP控制台下的接口管理菜单中选择环境管理,点击新建服务环境;

在弹窗页面,选择服务环境,填写服务端点和统一接口端点,并分别选择委托网关认证方式和网关到服务认证方式;最后点击确定创建环境。

说明: 如果您的服务和aecore部署在同一个k8s集群,需要采用 http://服务名.namespace.svc的形式配置服务端点。 在环境中定义的委托网关认证方式是默认的全局API认证方式, 比如您的服务大部分都是OAuth2的认证,但有个别接口,不需要认证,这时你可以在API列表里将该API认证配置设置为无认证覆盖在环境中的配置。

# 创建API

在SP控制台下的接口管理菜单中选择API列表,进行API的创建。这里提供两种创建API的方式供您选择,分别是创建单个API和通过swagger批量创建API。

步骤二:创建API

  • 方式一:创建单个API

在API列表页面点击新建API后依次填写API基本信息、网关API、后端API。

API基本信息包括API名称,认证方式,描述。

网关API定义通过网关访问的服务的信息,包括请求路径、方法和参数。

后端API定义网关转发的路径,包括请求路径、方法、参数和超时时间。

  • 方式二:通过导入Swagger批量创建API

在API列表页面点击导入swagger,选择导入的文件,同时仅可上传一个json文件。

选择文件之后点击预检。若请求路径、方法和http请求相同时,对应api状态为修改,提交后会覆盖原有API;反之为新增。覆盖原有API后,需要二次发布才生效。

# 绑定scope

您可以选择为API绑定scope进行权限的控制,ISV只有开通了对应API所绑定的scope权限才能访问服务API。

在scope管理界面点击新建scope。

在API列表界面点击更多,选择绑定scope进行scope绑定。

# 发布API

在API列表页面点击发布将对应API发布到指定的环境。

也可以批量发布多个API。在左侧勾选多个API之后点击批量发布。

# 调用API

成功发布API之后,我们通过Postman调用/go接口进行测试。因为接口设置了OAUTH2认证,所以需要获取访问服务的token,可参照如下接口鉴权文档。调用结果如下图,可以看出不携带token时访问失败。

  • 在线客服

  • 意见反馈