检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现，内部之间相互调用实现资源共享。 例如，部门A在ROMA API开放API，设计API、生成产品并上架到API目录，部门B通过API目录查看和订阅API。此时，部门A
丰富的API安全、运维能力。 API测试 通过导入API生成测试用例，快速实现API测试的覆盖。 API消费 ROMA API提供内部市场的能力，将API包装成API产品，支持上架到API目录中，提供完整的API文档展示能力，以及订阅功能。 API分析 提供可视化的API指标数据，方便API管理者进行维护和运营。
API产品 创建API产品 上架目录 管理API产品 父主题： API消费
API设计配置 ROMA API提供了API设计文件规范性检查，帮助用户快速设计标准的RESTful API。您可以选择已有的规则集或者新建规则集对API设计文件进行规范性检查。 ROMA API也支持配置扩展字段，您按照Swagger规范性设计API的同时，也可额外自定义扩展字段。
功能总览 功能总览 全部 ROMA API API设计 API实现 API管理 API消费 API分析 管理中心 API SDK OBS 2.0支持ROMA API ROMA API为企业构建规范化的API全流程体系，将企业服务能力包装成标准API服务，上架市场进行售卖。变现自身服
创建API设计 ROMA API提供了可视化的API在线设计能力，及接口规范性检查，帮助用户快速设计标准的RESTful API。在开始设计API前，您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
使用APP认证调用API 认证前准备 APP认证工作原理 Java Go Python C# JavaScript PHP C++ C Android curl
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后，消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API，那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网
发布API 在API创建后，您需要把API发布到环境，API只有在发布到环境后，才支持被其他用户调用。 作为初级使用者，成功创建API后，您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者，在创建API服务时，您可以把服务部署到环境上，同时间接地发布API。
API消费 API产品 API目录 审核管理 调用API
创建API服务 ROMA API提供了API服务能力，通过API服务把后端服务封装成标准RESTful格式API，并开放给其他用户使用。 目前支持三种创建服务方式： 创建API服务 创建一个简单的服务，不包含API，用户可自行创建API。 导入API设计文件 支持从“API设计”中导入设计文件，同步创建服务。
导入API服务：从“API服务”中选择API导入，生成测试用例。选择API服务，单击“确定”。 导入API设计文件：从“API设计”选择API导入，生成测试用例。选择API设计文件，单击“确定”。 导入Swagger文件：从用户本地导入API，生成测试用例。选择API文件，单击“打开”。 配置用例参数。
API管理 API服务管理 APIs管理 API列表 策略管理 自定义认证 SSL证书管理 API测试 凭据管理
API服务管理 创建API服务 导出API服务 生成产品 绑定域名 配置环境和环境变量 配置网关响应 父主题： API管理
选择待导出API所在的部署环境。 API 默认导出API服务在所选择环境下的所有API。如果只需要导出个别API，可单击“自定义导出API”，勾选需要导出的API。 API定义范围 选择导出的API服务文件中，API定义字段的类型范围。 基础定义：包括API前端请求定义和响应定义，不包括后端服务定义。其中A
APIs管理 创建API 调试API 发布API 管理API 流量控制 访问控制 签名密钥 跨域资源共享 父主题： API管理
API全生命周期 本手册主要介绍以API设计者、API开发者、API管理者和API消费者角色和流程来定义API的生命周期，包含了API设计、API实现、API管理、API消费和API分析五大流程。API资产从Swagger文档、后端能力、API服务和API产品在流程中轮转，并不断演进。 应用是一
使用IAM认证调用API Token认证 AK/SK认证
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。
APP认证工作原理 构造规范请求。 将待发送的请求内容按照与API网关（即API管理）后台约定的规则组装，确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到H
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
