网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

中级使用者入门指导

更新时间:2022-01-18 GMT+08:00
分享

作为中级使用者,在线设计API文件和上架API目录,需要完成以下流程:

图1 中级使用者流程图

准备工作

  • 已准备虚拟私有云、子网和安全组。
  • 已在本地PC上下载并安装接口调试工具。

步骤一:购买实例

  1. 选择实例类型。
    1. 登录ROMA API控制台,单击,选择区域。
    2. 在左侧导航栏选择“管理中心 > 实例管理”。
    3. 单击“购买实例”。
    4. 选择实例类型,以APIG实例为例。
  2. 购买实例。
    1. 创建APIG实例。
      图2 配置实例信息
      表1 配置实例信息

      参数

      配置说明

      计费模式

      选择实例的计费模式,此处选择“按需计费”。

      区域

      选择实例所在的区域,此处选择“华北-北京四”。

      可用区

      选择实例所在的可用区,此处选择“可用区1”。

      实例名称

      填写实例的名称,根据规划自定义。建议您按照一定的命名规则填写实例名称,方便您快速识别和查找。

      实例规格

      选择实例的容量规格,实例创建后规格不可修改,此处选择“基础版”。

      时间窗

      选择技术支持对实例进行维护的时间段,建议选择业务量较少的时间段,保持默认设置“22:00:00---02:00:00”。

      企业项目

      选择实例所属的企业项目,保持默认设置“default”。

      公网入口

      为简单起见,此处不开启。

      公网出口

      为简单起见,此处不开启。

      IPv6

      为简单起见,此处不开启。

      网络

      选择已准备VPC和子网。

      安全组

      选择已准备安全组。

      描述

      填写实例的描述信息。

    2. 单击“立即购买”。
    3. 勾选同意协议,单击“提交”。

步骤二:创建应用

  1. 在左侧导航栏选择“总览”或“管理中心 > 应用管理”。
  2. 单击“创建应用”。
  3. 配置应用信息,关联步骤一中实例。
    图3 创建应用
  4. 单击“创建”。
  5. 应用创建完成后,在页面左上角“ROMA API”下切换已创建的应用。

步骤三:创建API设计

  1. 在左侧导航栏单击“API设计”。
  2. 单击“创建API文件”,选择“导入Swagger文件”导入本地API设计文件。
  3. 编辑API,并单击“规范性检查”,按照“Compliance”提示修改内容。
    图4 创建API设计
  4. 单击“保存”。

步骤四:后端开发(可选)

  1. 在左侧导航栏选择“API实现 > 后端开发”。
  2. 单击“创建后端”,选择“导入API设计”。
  3. 选择API设计文件,单击“确定”。
    1. 后端配置
      表2 后端参数配置

      参数

      配置说明

      后端名称

      填写后端的名称,建议您按照一定的命名规则填写实例名称,方便您快速识别和查找。

      归属项目

      在创建应用时需要关联项目,默认步骤二中关联项目。

      新建代码仓

      填写代码仓的名称。

      新建流水线

      选择流水线构建类型,此处选择“Maven构建”。

      后端描述

      填写后端的描述信息。

    2. 代码配置
      表3 代码参数配置

      参数

      配置说明

      GroupId

      项目组织标识符,此处填写“com.huawei”。

      ArtifactId

      Maven中项目的名称,此处填写“romaapi”

      Name

      对应Maven项目中的“name”应用名称,此处填写“romaapi”。

      Description

      项目描述。

  4. 单击“创建”。
  5. 单击“在线开发”页签。
    1. 在IDE右侧资源管理器中打开“src>main>java>com>example>demo>DeomApplication.java”文件,将原有代码替换为如下代码。
      package com.example.demo;
      import org.springframework.boot.SpringApplication;
      import org.springframework.boot.autoconfigure.SpringBootApplication;
      import org.springframework.web.bind.annotation.GetMapping;
      import org.springframework.web.bind.annotation.RestController;
      
      @SpringBootApplication
      @RestController
      public class DemoApplication {
          public static void main(String[] args) {
          SpringApplication.run(DemoApplication.class, args);
          }
      
          @GetMapping("/")
          public String hello() {
          return "Hello, Devstar!";
          }
      }
      添加的代码中:
      • @RestController表明这个类是可以处理请求的控制器类。
      • @GetMapping("/")表明使用hello()方法来应答由http://localhost:8080/发出的请求。
    2. 编译执行代码,验证结果。

      在IDE中编译修改后的代码,并运行,验证打开内容为“Hello,DevStar”的Web页面。

      1. 在IDE中,单击菜单栏的“终端 > 新建终端”,在界面下方弹出的终端中输出如下命令并回车执行。
        mvn clean compile

        命令执行后,等待片刻,终端会输出如下信息,提示“BUILD SUCCESS”,表示编译成功。

        ...
        [INFO] ------------------------------------------------------------------------
        [INFO] BUILD SUCCESS
        [INFO] ------------------------------------------------------------------------
        ...
      2. 在IDE的代码区中,单击下图中的“Run”运行后端。

        Tomcat初始化过程中需要监听8080端口,IDE右下角将提示8080端口被监听,请单击“确定”。

        在IDE右上角将弹出8080端口访问确认,请单击“确定”,允许外部访问8080端口。

        8080端口允许访问后,单击右上角“访问”即可访问运行中的应用。

        应用访问成功后,将打开一个新的Web网站,页面中显示如下信息。

  6. 单击“后端总览”页签。
  7. 在“流水线”区域,单击“执行”。
  8. 流水线执行成功后,单击“克隆/下载”下载流水线的jar包,将包部署到自己的服务器上。

步骤五:创建API服务

  1. 单击“导入到API服务”。
  2. 导入前,对API文件进行导入规则检查。
    • 需修复问题,请单击“修复问题”,根据“API Rule Check”提示修改。
    • 无问题修复,请单击“继续导入”。
  3. 选择步骤一中实例,填写服务名称,并选择API接口。
  4. 单击“全局配置(可选)”,定义API服务。
    图5 全局配置
    1. 安全配置:选择认证方式,此处选择“APP认证”。
    2. 后端请求配置。
      表4 后端请求参数配置

      参数

      配置说明

      后端服务类型

      选择后端服务类型,此处选择“HTTP&HTTPS”。

      负载通道

      “不使用”负载通道。

      URL

      URL地址

      • 请求协议:HTTP
      • 后端服务地址:192.168.1.1:1234为•步骤四:后端开发部署后的后端服务地址或用户自己的后端服务地址。

      自定义host头域

      为简单起见,此处不配置。

      后端超时

      请求超时时间,此处填写“5000”ms。

      TLS双向认证

      为简单起见,此处不配置。

      后端认证

      为简单起见,此处不配置。

  5. 单击“完成”。
  6. 单击“确定”,将服务发布到“RELEASE”,页面自动跳转到“API运行”页面。

步骤六:配置策略

  1. 在“API运行”客户端右上方单击,选择“流量控制”。
  2. 配置流量控制策略。
    图6 配置流量控制策略
    表5 配置流量控制策略

    参数

    配置说明

    配置方式

    支持选择已有策略或创建新策略,此处选择“创建新策略”。

    策略名称

    API流控策略名称,建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。

    类型

    流控类型,此处选择“基础流控”,针对单个API进行流量统计和控制。

    时长

    流量限制的时长,此处设置“4小时”。

    API流量限制

    单个API被调用次数上限100次。

    用户流量限制

    单个用户调用API次数上限,为简单起见,此处不配置。

    应用流量限制

    单个应用调用API次数上限,为简单起见,此处不配置。

    源IP流量限制

    单个IP地址调用API次数上限,为简单起见,此处不配置。

    描述

    关于控制策略的描述。

  3. 单击“确定”。

步骤七:调试API

  1. 单击“调试”。
  2. 填写请求参数,单击“调试”。
    在页面下方显示请求消息和响应结果,若调试成功,状态码显示“200”。
    图7 调试

步骤八:绑定域名

  1. 单击“基本信息”页签。
  2. 在“域名管理”区域,单击“绑定独立域名”。
  3. 填写域名配置信息。
    表6 独立域名配置

    参数

    配置说明

    域名

    填写要绑定的域名。

    绑定的域名需要您在域名服务商处购买,并配置解析到对应的实例。

    支持最小TLS版本

    选择域名访问所使用的最小TLS版本,此处选择“TLS1.2”。

  4. 单击“确定”。

步骤九:创建产品

  1. 单击“生成产品”。
  2. 填写产品信息,并添加版本和API。
    图8 创建产品
  3. 单击“立即创建”。

步骤十:上架目录

  1. 在左侧导航栏选择“API消费 > API产品”。
  2. 单击步骤九中已建产品名称。
  3. 选择产品版本,单击“上架”。
  4. 单击“确定”。
  5. 在左侧导航栏选择“API消费 > 审核管理”。
    1. 在“我审核的申请”中,在已提交的申请所在行,单击“查看详情”。
      图9 申请详情
    2. 确定审核信息无误后,选择审核结果,填写反馈建议。
    3. 单击“确定”。

步骤十一:订阅产品

  1. 在左侧导航栏选择“API消费 > API目录”。
  2. 选择已上架产品,单击“订阅”。
  3. 配置订阅产品信息。
    图10 配置订阅产品信息
    1. 选择版本号。
    2. 在“订阅凭证”区,单击“新创建”。
    3. 填写凭证名称。
  4. 单击“确定”。

步骤十二:调用API

  1. 获取API的请求信息。
    1. 在左侧导航栏选择“API消费 > API产品”。
    2. 单击步骤九中已建产品名称。
    3. 单击已订阅版本号。
    4. 单击API名称,查看API接口认证方式、请求方法、URL和请求参数。
      图11 获取API的请求信息
  2. 获取“凭证信息”的Key和Secret。
    1. 在左侧导航栏选择“API消费 > API目录”。
    2. 单击“订阅与凭证”页签。
    3. 选择步骤十一中已创建凭证,查看“凭证信息”的“Key”和“Secret”。
  3. 使用接口测试工具配置调用信息。
    1. 配置获取的API请求信息。
    2. 添加Header参数“X-HW-ID”,参数值为“凭证信息”的“Key”。
    3. 添加Header参数“X-HW-AppKey”,参数值为“凭证信息”的“Secret”。
  4. 调用成功后,显示“200 OK”。

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容