检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
应用是一个系统资源的集合,下面可以划分不同的服务。 步骤三:创建API设计 快速在线设计标准的RESTful API。 步骤四:后端开发(可选) 支持一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力。 步骤五:创建API服务 将已创建的API设计文件导入API服务,开放给消费者使用。 步骤六:配置策略
开启绿色通道后,需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API;黑名单中的地址不允许调用API。 单击“确定”,完成授权。 下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 选择需要下线的API。 单击“下线”,选择需要下线的环境。 单击“确定”,完成下线。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 单击“创建API文件”。 在弹窗中修改“名称”,或默认系统自动生成的名称;根据下表说明,选择模板。 表1 API文件模板 模板类型 类型说明 SimpleAPI 提供简单GET请求样例。 DescriptionWithGFM
数,携带的Key和Secret(或客户端的AppKey和AppSecret)进行API的调用认证。 使用app_secret认证时,需同时关闭app_api_key认证方式。 app_route 支持IP访问开关。启用后,非DEFAULT服务下的API可以使用IP地址调用。 ba
API的实例配置参数“app_secret”已设置为“on”,开启app_secret认证,且“app_api_key”已设置为“off”,关闭app_api_key认证。 在API请求中添加Header参数“X-HW-ID”,参数值为API所授权的Key或客户端的AppKey。
对API设计文件的接口地址进行调测。 在页面中单击API设计文件名称,进入API编辑页面。 单击“编辑器”页签。 在编辑窗口上方开启“Mock”会自动生成Mock服务地址,您可以在可视化窗口对接口地址进行调测。 规范性检查 在API设计过程中提供接口规范性检查,帮助用户快速设计标准的RESTful
快速识别和查找。 策略类型 选择策略的类型,不同类型的策略提供不同扩展能力。 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。 HTTP响应头管理策略:可以自定义HTTP响应头,在返回的API响应中指定配置的响应头。 可见范围 当实例
间格式:YYYYMMDDTHHMMSSZ。如果API发布到非RELEASE环境时,需要增加自定义的环境名称。 客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关除了校验时间格式外,还会校验该时间值与网关收到请求的时间差,如果时
凭证创建完成后,您还可以执行如下列操作。 去订阅 通过已创建凭证订阅API产品。 重置Secret 在“凭证信息”区域,凭证“Key”和“Secret”是创建凭证后自动生成的,如需修改密码,单击“重置Secret”重置即可。注意重置后无法恢复,请谨慎操作。 编辑凭证 如需修改凭证信息,单击“编辑凭证”即可。
如果API已定义formData类型参数,将不展示Body参数,且暂不支持调试。 IAM认证 支持Token认证或AK/SK认证。Explorer自动获取或临时生成Token或AK/SK。 无认证 填写API的Headers参数。 自定义认证 单击“调试结果”页签,查看调试结果。 父主题:
在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 参数 配置说明 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。 AppCode 仅手动输入方式需要填写AppCode的值。 绑定凭据配额策略
关联项目资源,单击,选择项目。 单击“创建”。 应用创建完成后,您可以在页面左上角“ROMA API”下切换待操作的应用。 首次创建应用后,页面自动跳转到“API设计”,可根据业务需求自行创建设计文件。 应用授权 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
什么是ROMA API ROMA API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现,内部之间相互调用实现资源共享。 例如,部门A在ROMA API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A