api-gateway组件针对于云厂商的api网关产品开发而来：避免重复复杂的操作，采用简单的统一配置文件（s.yaml），快速完成api网关的配置和部署。
🙋 两步即可上手api-gateway组件的使用：
❶ 完成极简或全面的配置（一切通过s.yaml文件）
❷ 使用s api-gateway deploy快速部署你的第一个api网关组吧
对于一个s.yaml文件，我们如果需要配置两个api网关，最简单的方式可以是这样：
edition: 1.0.0 # 命令行YAML规范版本，遵循语义化版本（Semantic Versioning）规范
name: component-test # 项目名称
access: default # 密钥别名
vars: # [全局变量，提供给各个服务使用]
region: cn-hangzhou
services:
api-gateway:
component: api-gateway
props:
groupName: auto #组名，当为auto时，默认随机生成一个组名
instanceId: yourInstanceId
region: ${vars.region} #使用全局的地区设置
apis:
- apiName: api1
requestConfig: #api网关前端配置
requestPath: /add
serviceConfig: #api网关后端配置
servicePath: /api/add
serviceAddress: http://www.example.com
- apiName: api2
requestConfig:
requestPath: /mul
serviceConfig:
servicePath: /newApi/mul
serviceAddress: http://www.example2.com当然，更多灵活的配置我们也需要支持，对于如请求方法，域名，参数位置等，我们可以通过扩展s.yaml文件来进行设置。更多参数可见 详细配置
使用deploy指令，我们可以根据s.yaml文件快速的新建并部署一个api网关组。
如果我们在s.yaml中指定了api网关组，则组件会将本地的网关配置和远程进行比较，进行修改或是新增api网关组即相关配置
| 参数全程 | 缩写 | 是否必填 | 含义 |
|---|---|---|---|
| --help | -h | 否 | 查看deploy指令帮助文档 |
| --use-local | 否 | 使用本地 (此时远程应已有相应的api组配置，修改后将重新部署到线上) | |
| --use-remote | 否 | 使用远程 |
使用remove指令，我们可以快速删除s.yaml文件中指定的api网关组。请注意： 若线上本身就没有该apiGroup，也会成功返回，但是会提示无该api组
使用domain指令，我们可以快绑定域名，其使用方式为：
s api-gateway domain xxx.com
根据所传参数，组件将会尝试将自定义域名绑定在该网关组上。实际使用中，我们只需要将xxx.com换成您需要绑定的域名即可。
请注意： 域名在绑定之前，需要我们将其备案并且正确解析，详细步骤可参考：分组的域名绑定。
对于一个最简单的配置文件来说（如下面列出的yaml局部文件）：
gateway:
component: api-gateway
props:
groupName: auto #组名，当为auto时，默认随机生成一个组名
apis:
- apiName: api1
requestConfig: #api网关前端配置
requestPath: /add
serviceConfig: #api网关后端配置
servicePath: /api/add
serviceAddress: http://www.example.com
- apiName: api2
requestConfig:
requestPath: /mul
serviceConfig:
servicePath: /newApi/mul
serviceAddress: http://www.example2.com那么它的以下配置将是默认的：
-
api网关组
-
api网关
visibility: PRIVATE #该api不公开，当该组API在云市场上架时，私有类型的API不会上架。 authType: ANONYMOUS #允许匿名调用 resultType: JSON #后端服务返回应答的格式 resultSample: "200", forceNonceCheck: false #不检查X-Ca-Nonce disableInternet: false #不限制调用 backendEnable: false #不启用后端服务 webSocketApiType: COMMON #双向通信API类型：COMMON：普通API requestConfig: '{"requestProtocol":"HTTP,HTTPS","requestHttpMethod":"ANY","requestMode":"PASSTHROUGH"}' #普通请求，HTTP协议，请求模式为入参穿透，请求方式为any serviceConfig: '{"serviceProtocol":"HTTP","serviceHttpMethod":"ANY","serviceTimeout":"10000"}' #HTTP协议，请求方式为any，10000ms的延时
以及其他未被列出的配置，有些是非必填项或是暂时不需要关注到的，这里也没有涉及。
如果我们需要进一步对配置文件编辑，这里有一份配置清单：
{
"region": {
"Description": "网关分组部署的地域",
"Required": true,
"Example": "cn-hangzhou",
"Default": "cn-hangzhou",
"Type": "String"
},
"defaultDomain": {
"Description": "用户默认域名,只可在api组修改时添加该属性",
"Required": false,
"Example": "",
"Default": "",
"Type": "String"
},
"groupName": {
"Description": "分组名，详细查看apigateway关于分组的介绍",
"Required": true,
"Default": "",
"Type": "String"
},
"instanceId": {
"Description": "api网关组实例",
"Required": false,
"Default": "api-shared-vpc-002",
"Example": "/test",
"Type": "String"
},
"basePath": {
"Description": "api网关组的公共path",
"Required": false,
"Type": "String"
},
"apis": {
"Description": "api 列表",
"Required": true,
"Type": [
{
"List<Struct>": {
"apiName": {
"Description": "api名字",
"Required": true,
"Example": "",
"Default": "",
"Type": "String"
},
"allowSignatureMethod": {
"Description": "当AuthType为APP认证时，需要传该值明确签名算法。",
"Required": false,
"Example": "",
"Default": "",
"Type": "HmacSHA256" | "HmacSHA1,HmacSHA256"
},
"appCodeAuthType": {
"Description": "当AuthType为APP认证时，可选值如下:DEFAULT: 不传默认是DEFAULT(随分组设置) DISABLE: 不允许 HEADER: 允许AppCode的Header认证 HEADER_QUERY: 允许AppCode的Header及Query认证",
"Required": false,
"Example": "",
"Default": "",
"Type": "DEFAULT" | "DISABLE" | "HEADER" | "HEADER_QUERY"
}
"authType": {
"Description": "API的认证方式从匿名变为APP认证",
"Required": false,
"Example": "",
"Default": "",
"Type": "boolean"
}
"requestConfig": {
"Description": "请求配置",
"Required": true,
"Example": "",
"Default": "",
"Type": {
"Struct": {
"requestPath": {
"Description": "api请求的路径",
"Required": true,
"Example": "/",
"Default": "/",
"Type": "String"
},
"requestHttpMethod": {
"Description": "api请求的方法",
"Required": false,
"Example": "GET|POST|ANY",
"Default": "ANY",
"Type": "String"
},
"requestMode": {
"Description": "入参请求模式",
"Required": false,
"Example": "PASSTHROUGH|MAPPING",
"Default": "PASSTHROUGH",
"Type": "String"
},
"bodyModel": {
"Description": "请求体",
"Required": false,
"Example": "",
"Default": "",
"Type": "String"
},
"bodyFormat": {
"Description": "",
"Required": true,
"Example": "",
"Default": "",
"Type": "String"
},
"postBodyDescription": {
"Description": "",
"Required": true,
"Example": "",
"Default": "",
"Type": "String"
}
}
}
},
"serviceConfig": {
"Description": "后端服务配置",
"Required": true,
"Example": "",
"Default": "",
"Type": {
"Struct[函数计算配置模式]": {
"serviceProtocol": {
"Description": "后端服务类型",
"Required": true,
"Example": "HTTP|HTTPS|FunctionCompute|OSS",
"Default": "FunctionCompute",
"Type": "String"
},
"servicePath": {
"Description": "后端服务路径",
"Required": true,
"Example": "",
"Default": "/",
"Type": "String"
},
"functionComputeConfig": {
"Description": "函数计算配置项",
"Required": true,
"Example": "",
"Default": "",
"Type": {
"Struct[http函数类型配置]": {
"fcRegionId": {
"Description": "函数计算的region",
"Required": true,
"Example": "cn-hongkong|cn-hangzhou",
"Default": "cn-hongkong",
"Type": "String"
},
"fcBaseUrl": {
"Description": "fc 触发器基础地址",
"Required": true,
"Example": "",
"Default": "",
"Type": "String"
},
"path": {
"Description": "函数计算访问路径",
"Required": true,
"Example": "",
"Default": "",
"Type": "String"
},
"fcType": {
"Description": "函数计算类型",
"Required": true,
"Example": "HttpTrigger",
"Default": "HttpTrigger",
"Type": "String"
},
"serviceName": {
"Description": "服务名称",
"Required": true,
"Example": "",
"Default": "",
"Type": "String"
},
"functionName": {
"Description": "函数名称",
"Required": true,
"Example": "",
"Default": "",
"Type": "String"
},
"roleArn": {
"Description": "arn ",
"Required": true,
"Example": "acs:ram::{accountID}:role/{ramRoleName}",
"Default": "",
"Type": "String"
},
"onlyBusinessPath": {
"Description": "是否只传递路径",
"Required": false,
"Example": "",
"Default": "true",
"Type": "Boolean"
},
"contentTypeCategory": {
"Description": "ContentType是否透传",
"Required": false,
"Example": "CLIENT",
"Default": "CLIENT",
"Type": "String"
}
}
}
},
"resultType": {
"Description": "返回类型",
"Required": false,
"Example": "JSON",
"Default": "JSON",
"Type": "String"
}
}
},
{
"Struct[普通HTTP(s)模式]": {
"serviceAddress": {
"Description": "后端服务地址",
"Required": true,
"Example": "",
"Default": "",
"Type": "String"
},
"aoneAppName": {
"Description": "后端应用命名",
"Required": true,
"Example": "cloudapi-openapi",
"Default": "cloudapi-openapi",
"Type": "String"
},
"servicePath": {
"Description": "后端服务路径",
"Required": true,
"Example": "/index.html",
"Default": "/",
"Type": "String"
},
"serviceHttpMethod": {
"Description": "后端服务的方法",
"Required": true,
"Example": "GET",
"Default": "GET",
"Type": "String"
},
"serviceProtocol": {
"Description": "后端服务协议",
"Required": true,
"Example": "HTTP",
"Default": "HTTP",
"Type": "String"
},
"resultType": {
"Description": "返回类型",
"Required": true,
"Example": "JSON",
"Default": "JSON",
"Type": "String"
}
}
}
]
}
},
"requestParameters": {
"Description": "Consumer向网关发送API请求的参数描述。",
"Required": false,
"Example": '[{"ParameterType":"Number","Required":"OPTIONAL","isHide":false,"ApiParameterName":"age","DefaultValue":"20","DemoValue":"20","Description":"年龄","MinValue":18,"MaxValue":100,"Location":"Head"},{"ParameterType":"String","Required":"OPTIONAL","isHide":false,"ApiParameterName":"sex","DefaultValue":"boy","DemoValue":"boy","Description":"性别","EnumValue":"boy,girl","Location":"Query"},{"ParameterType":"Number","Required":"REQUIRED","isHide":false,"ApiParameterName":"userId","MaxLength":10,"MinValue":10000000,"MaxValue":100000000,"Location":"Path"},{"ApiParameterName":"CaClientIp","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","Description":"客户端IP"},{"ApiParameterName":"constance","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","DefaultValue":"constance","Description":"constance"}]',
"Default": "",
"Type": "String"
},
"serviceParameters": {
"Description": "网关向后端服务发送API请求的参数描述。",
"Required": false,
"Example": '[{"ServiceParameterName":"age","Location":"Head","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"sex","Location":"Query","Type":"String","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"userId","Location":"Path","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"clientIp","Location":"Head","Type":"String","ParameterCatalog":"SYSTEM"},{"ServiceParameterName":"constance","Location":"Head","Type":"String","ParameterCatalog":"CONSTANT"}]',
"Default": "",
"Type": "String"
},
"serviceParametersMap": {
"Description": "Consumer向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系。",
"Required": false,
"Example": '[{"ServiceParameterName":"age","RequestParameterName":"age"},{"ServiceParameterName":"sex","RequestParameterName":"sex"},{"ServiceParameterName":"userId","RequestParameterName":"userId"},{"ServiceParameterName":"clientIp","RequestParameterName":"CaClientIp"},{"ServiceParameterName":"constance","RequestParameterName":"constance"}]',
"Default": "",
"Type": "String"
},
"systemParameters": {
"Description": "api的公共参数，json格式",
"Required": false,
"Example": "",
"Default": "",
"Type": "String"
},
"disableInternet": {
"Description": "是否仅支持内网调用API。",
"Required": false,
"Example": "",
"Default": "",
"Type": "Boolean"
},
"errorCodeSamples": {
"Description": "后端服务返回的错误码示例",
"Required": false,
"Example": '[{"Code":"400","Message":"Missing the userId","Description":"参数错误"}]',
"Default": "",
"Type": "String"
},
"failResultSample": {
"Description": "后端服务失败返回应答的示例 该值仅用于生成文档使用。不对返回结果产生影响。",
"Required": false,
"Example": '{"errorCode":"fail","errorMessage":"param invalid"}',
"Default": "",
"Type": "String"
}
}
]
}
}
其中支持auto的字段为:
groupNameapi组名称 (不建议)basePathapi组基础路由
一些复杂字段，如requestParameters,除了传递字符串，也可以直接传递对象，组件内会自动处理这些对象为字符串
Serverless Devs FC 组件遵循 MIT License 开源许可。
位于node_modules和外部目录中的所有文件都是本软件使用的外部维护库，具有自己的许可证；我们建议您阅读它们，因为它们的条款可能与MIT License的条款不同。
您如果有关于错误的反馈或者未来的期待，您可以在 Serverless Devs repo Issues 或 Fc repo Issues 中进行反馈和交流。如果您想要加入我们的讨论组或者了解 FC 组件的最新动态，您可以通过以下渠道进行：
 |
 |
 |
|---|---|---|
关注微信公众号：serverless |
联系微信小助手：xiaojiangwh |
加入钉钉交流群：33947367 |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent