检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
支持区域:华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二 创建API设计 管理规则集 OBS 2.0支持API实现 提供一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力,使后端开发无需从零开始。 支持区域:华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二
单击实例名称或实例卡片右上角的“查看控制台”。 单击“负载通道”页签。 单击“创建负载通道”。 根据下表参数说明,配置通道信息。 表1 负载通道参数说明 参数类型 参数项 说明 基本信息 通道名称 填写负载通道的名称,根据规划自定义。建议您按照一定的命名规则填写负载通道名称,方便您快速识别和查找。 端口
DK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 Reference Java huaweicloud-sdk-java-v3
在页面上单击服务名称,进入API服务详情页面。 单击页面右上角的“导出”。 在页面中配置导出参数,完成后单击“导出”,导出结果可在页面右侧查看,同时支持下载到本地。 表1 API服务导出配置 参数 配置说明 API服务 选择待导出API所在的API服务。 运行环境 选择待导出API所在的部署环境。
单击“Explorer”页签,选择版本号进入。 页面的最左侧展示产品下的API,中间可配置API请求参数,最右侧支持查看调试结果和API文档。 (可选)单击“文档”页签,查看API文档信息。 根据已设置认证方式,编辑请求参数,单击“调试”。 表1 请求参数说明 认证方式 Headers
配置跨域访问API 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 浏览器将CORS请求分为两类 简单请求 非简单请求 详情请参考配置跨域访问API。 父主题:
跨域资源共享 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源,而CORS允许浏览器向跨域服务器,发送XMLHttpRequest请求,从而实现跨域访问。 前提条件 API已发布。 配置跨域访问控制 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
跨域资源共享策略 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。更多跨域访问的说明请参考开启跨域共享。 跨域资源共享策略为跨域访问提供指定预检请求头和响应
),请将调试域名更改为实例的弹性IP地址,并且header中需添加参数host,值为调试域名。 单击执行测试。 若执行失败,可单击“查看结果”,查看日志定位原因。 更多详细操作,请参考快速入门。 父主题: API管理
... } } } OnAuthorization函数为签名校验代码。校验流程如下:使用正则表达式解析Authorization头。得到key和signedHeaders。 1 2 3 4 5 6 7 8 9 10 11 12
return wrapped return wrapper wrapped函数为签名校验代码。校验流程如下:使用正则表达式解析Authorization头。得到key和signedHeaders。 1 2 3 4 5 6 7 8 if "authorization"
单击已订阅版本号。 单击API名称,查看API接口认证方式、请求方法、URL和请求参数。 图11 获取API的请求信息 获取“凭证信息”的Key和Secret。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。 选择步骤十一中已创建凭证,查看“凭证信息”的“Key”和“Secret”。
request = new RequestWrapper((HttpServletRequest) servletRequest); 使用正则表达式解析Authorization头,得到signingKey和signedHeaders。 1 2 3 4 5 6 7 8 9
API设计文件的变更记录。支持查看变更前后的内容和还原变更内容。 查看全局API设计文件的变更历史 在页面右上角单击“API变更历史”,进入变更列表页面。 通过变更时间、请求方式或URL筛选变更信息。 单击“查看详情”,可通过文本形式或表单形式查看变更内容。 查看单个API设计文件的变更历史
端。 身份来源 设置用于认证的请求参数。 当“类型”为“前端”,且“缓存时间”不为0时,必须设置此参数。使用缓存时,此参数将作为搜索条件来查询认证结果。 缓存时间 设置认证结果缓存的时间。 值为0时代表不缓存,最大支持3600秒。 是否发送body 指是否将API请求的body体
配置API是否支持跨域访问CORS。 CORS请求分为两类: 简单请求:头信息之中,增加一个Origin字段。 非简单请求:在正式通信之前,增加一次HTTP查询请求。 开启CORS(非简单请求)时,您需要单独创建一个“Method”为“OPTIONS”的API,具体操作请参考开启跨域访问。 后端请求配置。
Petstore 提供多种复杂API的定义样例。 单击“确定”,跳转到API设计文件的“编辑器”页面。 页面左侧为API列表,可选择API或数据模型查看。 页面中间为API的编辑窗口,编辑API时应遵循Swagger 2.0规范定义。 页面右侧为API的可视化视图窗口。 在编辑API设计文
根据下表参数信息,配置前端定义。 表1 前端定义参数 信息项 描述 API名称 API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 URL 前端地址由请求方法、请求协议、子域名和路径组成。 请求方法:GET、POST、DELETE、PUT、PATCH、HEAD、OP
Description 项目描述。 单击“创建”,页面自动跳转到“后端总览”,支持查看后端“基本信息”、“代码仓库”和“流水线”信息。 后端创建完成后,您可以在“代码仓库”中: 单击“浏览代码”,查看代码库。代码仓库是代码托管服务存储代码的云端仓库。 单击“在线开发”,通过云端开发
单击“确定”,完成访问控制策略的创建。 获取账号名 登录管理控制台。 获取账号名。 将鼠标移至用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面查看账号名。 图2 查看账号名 父主题: APIs管理