快速入门

创建后端服务为HTTP(S)的API

作为服务开发者，希望能将部分API暴露出去，提供给调用者使用。API网关提供这种能力，将企业服务通过API能力开放出去。

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

(1) 创建API分组，关联后端HTTP(S)服务。

a. 访问协议选择HTTP or HTTPS。

b. 填写URL前缀，即后端服务的url前缀，填写后，代表访问时无需输入此路径；为空时表示不自动路由。

c. 填写后端超时，即API网关调用API后端服务的最大响应时间，如果响应时间超过该值，API网关会放弃请求后端服务，并给用户返回相应的错误信息。

d. 确定后，创建API分组成功，即关联后端HTTP(S)服务成功。

(2) 创建API，选择上面创建成功的API分组，选择网关对外暴露的API协议：HTTP\HTTPS；选择请求方法，支持单选/多选；填写访问路径（输入后端服务path），确定后，创建API成功。

(3) 进入API管理页面，点击此API对应的操作-发布API，选择发布环境，填写发布备注，选择域名&证书（非必填），确定后，发布成功。

(4) 发布成功后，可进入其API详情页面，进入“调试API”标签页中进行调试。访问地址是：http://网关ip地址/API访问地址，点击发送，查看响应结果。

用户可以将自己的域名绑定到API网关的API分组上，API网关通过域名来定位到一个唯一的API分组，再通过访问路径+访问方法（Path+HTTPMethod）来确定唯一的API。

(1) 首先参考3.1创建后端服务为HTTPS的API，即创建API分组时，选择访问协议必须选择是HTTPS，见下图。

(2) 发布前，必须添加域名&证书。如下图：（入口：API分组列表的操作中选择“添加域名&证书”，点击跳转API分组详情页面的“绑定域名”tab下，点击按钮“添加域名&证书”）。

(3) 发布后，调试API时，和普通的http请求的区别是：调用的时候一定要带上host信息，此处的host值即为配置域名&证书时填的域名，如下图所示。

作为dubbo服务开发者，希望能通过HTTP协议经过Proxy代理转化直接调用Dubbo接口。API网关提供这种能力，将企业Dubbo服务通过API能力开放出去。

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

创建API分组，关联后端dubbo服务。

a. 访问协议选择“Dubbo”。

b. 填写注册中心，例host:port。仅支持接入zookeeper注册中心的dubbo服务。详见8.1.1创建API分组。当zookeeper是高可用时，需要将其所有地址都填写完成，多个用英文逗号隔开。并需要进行测试链接。

c. 上传接口包：支持.jar文件，最大100M，上传新接口包将覆盖选择的服务中定义的接口文件。

d. 点击确定后，创建API分组成功，即关联后端Dubbo服务成功。

创建API，选择上面创建成功的API分组，选择网关对外暴露的API协议：HTTP\HTTPS，自动获取请求方法，访问路径是自动获取展示服务名称，然后选择要暴露的接口和方法，strip_path必须勾选。点击确定后，创建成功。

进入API管理页面，点击此API对应的操作--发布API，选择发布环境，填写发布备注，选择域名&证书（非必填），确定后，发布成功。

发布成功后，可进入其API详情页面，进入“调试API”标签页中进行调试。访问地址是 http://网关ip地址/dubbo服务名称/接口名称/方法名称；默认显示请求体 Body（JSON格式），点击<发送>，即可查看响应结果。