ROMA APIROMA API

更新时间:2021/07/08 GMT+08:00
分享

总览

ROMA API是API全生命周期治理经验的产品,如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题,提供了规范化的产品跟工具支撑,帮助企业快速实现API经济,并持续构建高质量的API服务能力。

图1 API全生命周期

本手册主要介绍以API设计者、API开发者、API管理者和API消费者角色和流程来定义API的生命周期,包含了API设计、API实现、API管理、API消费和API分析五大流程。API资产从Swagger文档、后端能力、API服务和API产品在流程中轮转,并不断演进。

应用是一个系统资源的集合,API的全生命周期是在应用中实现,因此在开启API的全生命周期管理之前,您需要在“管理中心”先创建应用

  1. API设计

    API设计者主要负责API整体的规划和设计,提前Mock调测和规范检查。

  2. API实现

    API开发者负责后端的业务开发、版本测试、验证、版本发布等。

  3. API管理

    API管理主要包含API服务、API策略和API测试能力,支持API服务定义和策略管理。

  4. API消费

    所有API的订阅者均属于API消费者,API管理者将从服务中挑选的部分API组合成API产品上架到API目录供API消费者订阅后调用。

  5. API分析

    快速获取并分析API指标,方便API管理者维护和运营。

基本概念

概念

说明

应用

API的全生命周期管理在应用中实现,应用是一个系统资源的集合,包含实例和项目等资源。

API设计

API设计提供API文档的标准化设计和变更管控。

API实现

API实现是API开发者在后端开发、部署和业务编排的能力。

API管理

API管理提供了API服务开放、配置运行策略、API安全配置等能力。

API消费

API消费用于帐号内部的API产品上架和订阅。

API分析

API分析提供了API指标分析。

API

API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API Connect开放给用户调用。API包括基本信息、前后端的请求路径和参数以及请求相关协议。

API服务

API服务是同一种业务API的集合,API开发者以API服务为单位,管理服务内的所有API。

API产品

API产品是从服务中挑选想要共享的API组合而成,即为将要上架的API的集合。

API目录

API目录用于帐号内部的API产品共享,IAM用户可以通过订阅不同的API产品实现API共享。

实例

实例是一个独立的资源空间,所有的操作都是在实例内进行,不同实例间的资源相互隔离。

操作指引

  1. 登录ROMA API控制台。
  2. 在控制台单击,选择区域。
  3. 在左侧导航栏单击“总览”。

    “总览”页面展示分别展示ROMA API概念,提供的能力,以及操作指引。

  4. 您可以根据不同角色查看行为路径,或者单击“查看指引”查看详细的操作指引。

    目前仅初级使用者支持“查看指引”。

分享:

    相关文档

    相关产品