阿里云
为了无法计算的价值
打开APP
阿里云APP内打开
学习中心> 阿里云API网关使用教程> 正文

阿里云API网关使用教程

5课时 |
1577人已学 |
免费
课程介绍

API 网关(API Gateway),提供API托管服务,涵盖API发布、管理、运维、售卖的全生命周期管理。辅助用户简单、快速、低成本、低风险的实现微服务聚合、前后端分离、系统集成,向合作伙伴、开发者开放功能和数据。

产品详情:https://www.aliyun.com/product/apigateway

创建一个API

 

内容简介

  1. API的创建过程
  2. 基本信息内容

 

一、API的创建过程

在API官网创建一个API,多是情况下是多个API协调来完成一个功能,在API的概念之上,我们还有一个API分组的概念,在API官网要录入一个API,首先要创建一个API分组。

在控制台进入分组管理,创建分组(输入分组名称并简述下名字和描述)

 

出现下面提示就表示分组创建成功。(二级域名后面会对域名进行讲解)

 

接下来创建API,点击API列表的这个页面,进入API管理的页面,点击创建API会出现我们选好了默认分组。

 

API,大概四个步骤

第一个就是基本信息,基本信息就是接口名称,简单的描述。

第二个就是API请求,一般习惯说是前段定义,就是从客户端到API网关这一段的请求结构的定义。

第三步是定义API的服务,一般说成是后端服务,就是指的是网关到明后端就是服务的那个请求结构。

第四步就是定义返回结果。

 

 

基本信息描述

以查询天气数据的为例,输入API名称,然后选取安全认证的方式,阿里云提供了三种认证方式,(这三种认证方式后面也会有详细的专门的视频来说关于认证的)类型是公开描述,这样基本信息创建完成,下面就进入下一步,

 

 

 

二、基本信息内容

 

定义API请求

指用户发起请求到网关的这一部分的请求结构,下面首先选的是他的协议,一般是支持http或者是httpps,在这选成两个都支持,然后自定义域名和二级域名(我们后面会有专门的视频来说域名)。

请求Path,

从用户到网关这一段儿请求结构里的Path,如果Path中有这个参数的话,就是说你的Path是带这样的动态参数的话,比如说我们叫Path,这里边参数也是可以的,(如果报错,可以先不用管。在下边配入参定义中把他对应上,这样就不会再报错了)。

 

定义Method。

开始入参的定义,用户请求的时候需要输入的参数,(首先针对上面的错误进行配参)类型不支持文件类型的,其余都可以用字符流的形式解决。

描述简单写一下,编辑更多是对这个参数的一些校验,比如说我们之前写了这个参数是int的类型,那个相应的就比如说一些枚举值的设置,随后他的最大值最小值都会设置。

 

这个请求到网关时候,网关就会先按照你配置的规则来对他进行交验了,如果不符合规则的话,会直接打回去,这样的话就会避免很多这种无效的请求,把这个后端的资源消耗掉。

 

除了Path的查询外还应该有其他的查询。

 

后端服务地址注意格式的演示,可是IP加一个端口也可是一个域名。

后端请求的path和前端的一样,可以和前端不一致网关支持映射。Method也支持映射。

 

后端超时:是在配置的这个时间之内,然后网关会等待以后的那响应,比如说配置各3300万毫秒,那么他就是30秒就说会等待30秒。

 

如果在30秒之内后端的响应,网关会报超时的这个错误了,所以一开始的时候可以把这个值设大一点,(最大支持30秒)后边进行调整等到稳定时再进行缩短。

Mock先不使用,如果把他设置成Mock的时候,他实际请求就永远调不到后端,就是配置一个Mock的结果,然后他就永远只返回这几个字。

后端服务参数配置,主要是对前端参数的一个映射,可以看右边的部分,他其实是已经把前端的都已经拉过来了