轻松使用阿里云资源编排，方便你的API管理

最新推荐文章于 2024-01-16 15:18:26 发布

chuangpangzhou2446

最新推荐文章于 2024-01-16 15:18:26 发布

阅读量119

点赞数

文章标签： json

原文链接：https://my.oschina.net/u/3722616/blog/1573922

版权

11月初，阿里云ROS正式发布API 网关（API Gateway）资源，为云计算用户提供高性能、高可用的 API 托管服务，帮助用户对外开放其部署在 ECS、容器服务等阿里云产品上的应用，提供完整的 API 发布、管理、维护生命周期管理。用户只需进行简单的操作，即可快速、低成本、低风险地开放数据或服务。

用户只需要按照自己的需求，根据ROS的模板规范，定义自己的API管理模板，就可以轻轻松松实现API组的创建/更新，API的创建/更新，API的发布或者版本切换，以及API授权，签名，流控等等的配置预更新。

以创建和发布一个新API到测试环境为例。首先用户先根据ROS的模板规范定义自己的模板，模板中会包含下面的几个资源，具体的资源介绍详见帮助文档，
ALIYUN::ApiGateway::Group,
ALIYUN::ApiGateway::API,
ALIYUN::ApiGateway::Deployment

一个最简单的模板定义如下：
{
"ROSTemplateFormatVersion": "2015-09-01",
"Description": "Create an API Gateway",
"Parameters": {
"CustomStage": {
"Type": "String",
"Description": "环境",
"AllowedValues": [
"TEST",
"PRE",
"RELEASE"
],
"Label": "环境",
"Default": "TEST"
}
},
"Resources": {
"Group": {
"Type": "ALIYUN::ApiGateway::Group",
"Properties": {
"GroupName": "my_api_group",
"Description": "my api group"
}
},
"Deployment": {
"Type": "ALIYUN::ApiGateway::Deployment",
"Properties": {
"Description": "liyi_test",
"StageName": {
"Ref": "CustomStage"
},
"ApiId": {
"Fn::GetAtt": [
"API",
"ApiId"
]
},
"GroupId": {
"Fn::GetAtt": [
"Group",
"GroupId"
]
}
}
},
"API": {
"Type": "ALIYUN::ApiGateway::Api",
"Properties": {
"RequestConfig": {
"RequestPath": "/my_resource",
"RequestProtocol": "HTTP,HTTPS",
"RequestHttpMethod": "GET",
"PostBodyDescription": "k:v",
"BodyFormat": "FORM"
},
"ResultSample": "my_test sample result",
"ServiceConfig": {
"ServiceAddress": "http://my_url_site",
"MockResult": "Nothing",
"ContentTypeValue": "application/x-www-form-urlencoded; charset=UTF-8",
"ServiceVpcEnable": "FALSE",
"ServiceTimeOut": 20000,
"ServiceProtocol": "HTTP",
"ServicePath": "/my_data",
"ServiceHttpMethod": "GET",
"ContentTypeCatagory": "DEFAULT",
"Mock": "FALSE"
},
"ApiName": "my_test_first_api",
"Visibility": "PRIVATE",
"AuthType": "APP",
"ResultType": "JSON",
"FailResultSample": "my_test faile sample result",
"GroupId": {
"Fn::GetAtt": [
"Group",
"GroupId"
]
}
}
}
},
"Outputs": {
"APIId": {
"Value": {
"Fn::GetAtt": [
"API",
"ApiId"
]
}
},
"GroupId": {
"Value": {
"Fn::GetAtt": [
"Group",
"GroupId"
]
}
}
}
}