阅读307 返回首页    go windows


API管理__使用手册(开放API)_API 网关-阿里云

API定义就是指您创建API时对API的请求结构的各方面定义。您可以在控制台完成API定义的查看、编辑、删除、创建、复制。您需要注意以下几点:

  1. 当您需要编辑某个API的定义时,如果该API已经发布,对定义的修改不会对线上产生影响,定义修改后需要再次发布才能把修改后的定义同步到线上环境。
  2. 当您想要删除某个API,如果该API已经发布,则不允许直接删除API定义,需要先将API下线,然后删除。
  3. 我们还为您提供了复制定义的功能。您可以从测试环境/线上环境复制线上的定义覆盖当前的最新定义,然后重新点击编辑进行修改。

API发布管理

当您完成API的创建后,您可以将API发布到测试或者线上。也可以将测试或者线上的API下线。您需要注意以下几点:

  1. API创建完成后,发布到某环境,通过二级域名或者独立域名访问时,需要在请求的Header指定要请求的环境,参见《请求示例
  2. 当您要发布某个API时,如果该API在测试或者线上已经有版本在运行,您的此次发布将使测试或者线上的该API被覆盖,实时生效。但是历史版本及定义会有记录,您可以快速回滚。
  3. 您可以将测试或者线上的某个API下线,下线之后,与策略、密钥、APP的绑定或者授权关系依然存在,再次上线时会自动生效。如果要解除关系,需要专门操作删除。

API授权管理

您的API如果上架到市场,那么购买者有权利操作给自己的某个APP授权。

如果不经过购买行为,您需要在线下跟合作伙伴建立使用关系,那么您需要通过授权来建立API和APP的权限关系。您将API发布到线上环境后,需要给客户的APP授权,客户才能用该APP进行调用。您有权对此类授权操作建立或者解除某个API与某个APP的授权关系,API网关会对权限关系进行验证。操作授权时,您需要注意以下几点:

  1. 您可以将一个或者多个API授权给一个或者多个APP。批量操作时,建议不要同时操作多个分组下的API。
  2. 批量操作时,先选择API后选择环境。比如一个API在测试和线上均有发布,最后选择了测试,就只会将测试下的该API授权。
  3. 您可以通过客户提供给您的AppID或者阿里云邮箱账号来定位APP。
  4. 当您需要解除某个API下某个APP的授权时,您可以查看API的授权列表,在列表页进行解除。

历史与版本切换

您可以查看您每个API的发布历史记录,包括每次发布的版本号、说明、环境、时间和具体定义内容。

查看历史时,您可以选定某个版本然后操作切换到此版本,该操作会使该版本直接在指定环境中替换之前的版本,实时生效。

最后更新:2016-11-23 16:04:04

  上一篇:go API开放__使用手册(开放API)_API 网关-阿里云
  下一篇:go 签名密钥__使用手册(开放API)_API 网关-阿里云