最佳实践

国内油价查询API帮助用户实时查询国内当天的汽油柴油的价格。本例将以服务商的角度详细介绍该API的上架过程，以帮助用户了解API资产上架步骤。

上架流程

API资产上架流程如下图所示。

(1) 服务商在对应的项目内，新建API分组，该分组须绑定对应的后端服务，其余参数可自定义。

(2) 服务商在同个项目内新建一个API，该API所属分组要选择步骤(1)创建的API分组，其余参数可自定义。

(3) API创建完成后，需要将API发布到对应的环境中；发布完成后，需要将API绑定对应的访问控制插件。

(4) 服务商将API配置完成后，将该API上架至市场。

(5) 服务商添加一个相应的资产，API资产添加完成后，将该资产与已经配置完成后API关联。

(6) 定义资产时选择步骤(1)的操作租户及项目集群，API选择步骤(3)~(4)配置完成的API。

准备工作

• 当前帐号已正确安装API运行环境及组件，且当前帐号可正常使用。
• 服务商已经上传部署国内油价查询API所需的容器镜像。
• 项目有足够的配额。

配置详情

由于API后端需要绑定一个服务，用户需提前获取服务地址等相关信息，用户也可在时速云平台创建相关的服务。

API配置

系统通过API的形式将后端服务（平台容器服务、传统主机服务）开放出来，提供给各方使用。也可关联数据库数据，发布成数据服务API。

发布至同一环境的API具有相同的访问地址，调用者将根据环境中定义的环境地址或域名访问开放的API服务。

配置API分组

前提条件

• 当前帐号已正确安装API运行环境及组件，当前帐号可正常使用。
• 相关服务正常运行。

配置API分组的操作步骤如下所示。

(1) 用户在控制台上部导航栏中，点击上部导航的[所有产品]菜单展示该租户所有可见菜单。

(2) 单击[API网关/开放API/API分组]菜单项，进入分组列表页面，用户自定义选择对应的项目集群。本示例中项目选择“tamp”，集群选择“北京一区”。进入目标分组列表页面。

(3) 单击<创建API分组>按钮，进入“创建分组”页面，填写各参数信息，具体的参数说明用户可查看开放API相关说明。

(4) 后端服务类型选择“自定义后端服务地址”，用户可自定义选择已有的后端服务，本例填写油价查询相关服务的后端地址。

(5) 参数配置完成后，单击<确定>按钮，所需的API分组创建完成。

配置API

前提条件

• 当前帐号已正确安装API运行环境及组件，当前帐号可正常使用。
• 相关服务正常运行；API分组已经创建完成。

API分组配置完成后，用户需要配置所需的API，配置步骤如下所示。

(1) 用户点击上部导航的[所有产品]菜单，展示该租户所有可见菜单。

(2) 单击[API网关/开放API/API管理]页签，进入API列表页面，项目选择“tamp”，集群选择“北京一区”，进入目标列表页面。

(3) 单击<创建API>按钮，进入“创建API”页面，填写各参数信息，具体的参数说明用户可查看开放API相关说明。

(4) API分组选择上一步创建的“spring-boot-05”，请求方法可以多选，本例选择“GET”，访问路径自定义填写，如下图所示。

(5) 参数配置完成后，单击<确定>按钮，所需API创建成功。

发布API

前提条件

• 当前帐号已正确安装API运行环境及组件，当前帐号可正常使用。
• 相关服务正常运行；API分组已正确配置；API已正确配置。

API发布的操作步骤如下所示。

(1) 用户点击上部导航的[所有产品]菜单项，展示该租户所有可见菜单。

(2) 单击[API网关/开放API/API管理]，进入API列表页面。项目选择“tamp”，集群选择“北京一区”，进入目标列表页面。

(3) 找到上一步创建的API“spring-boot-05-api”。单击<发布API>，进入API发布配置页面，填写各参数信息，具体的参数说明用户可查看开放API相关说明。

绑定插件

前提条件

• 当前帐号已正确安装API运行环境及组件，当前帐号可正常使用。
• 相关服务正常运行；API分组已正确配置；API已正确配置，且API已发布。

绑定API插件的操作步骤如下所示。

(1) 用户在控制台上部导航栏中，点击上部导航的[所有产品]菜单展示该租户所有可见菜单。

(2) 单击[API网关/开放API/API管理]，进入API列表页面。项目选择“tamp”，集群选择“北京一区”，进入目标列表页面。

(3) 找到上一步创建的API“spring-boot-05-api”。点击API名称链接，进入API详情页面。

(4) 切换至“绑定插件”页签，单击<绑定访问控制插件>按钮，选择插件，例如：default-basic-auth。

(5) 插件绑定完成后，单击<确定>按钮，插件绑定完成。

云市场配置

云原生应用市场是一款提供资产交易与交付功能的产品，可以实现应用、API、模型等多种交付介质的开放与交易，在开放自有应用建设生态应用的同时支持第三方服务商(ISV)驻云原生应用市场。

云原生应用市场为极大可能满足用户上云的所有需求。用户可以快速购买到合适的应用产品，轻松部署自己的业务，方便快捷。

添加资产

前提条件

• 服务商已注册公有云帐号，且帐号可正常使用。
• 当前帐号已正确安装API运行环境及组件，当前帐号可正常使用。
• 相关服务正常运行；API分组已正确配置；API已正确配置；API已发布；API已绑定访问控制插件。

添加资产的操作步骤如下所示。

(1) 服务商登录PaaS平台，选择对应的集群项目，点击[API网关/开放API/API管理]菜单项，进入API列表页面。

用户登录时速云官网 https://www.tenxcloud.com/，执行相关操作。

(2) 找到要上架到云市场的API，单击<上架至市场>按钮，进入资产添加配置页面，具体的参数配置，用户可参考资产接入相应说明。

(3) 选择交付类型为API，配置API规格参数，如下图所示。

(4) 资产添加操作完成后，单击<确定>按钮，资产添加操作完成。

定义API

前提条件

• 当前帐号已正确安装API运行环境及组件，当前帐号可正常使用。
• 在PAAS存在配置完成API，配置完成指的是API已经绑定所需的访问控制插件。

备注

建议用户使用个人租户下的API。

定义API的操作步骤如下所示。

(1) 服务商登录PaaS平台，选择对应的集群项目，点击[API网关/开放API/API管理]菜单项，进入API列表页面。

用户登录时速云官网 https://www.tenxcloud.com/，执行相关操作。

(2) 找到要上一步已经添加的资产，单击<定义API>按钮，进入API配置页面。

(3) 选择用户个人租户，选择“tamp”项目，集群选择“北京一区”，选择已经配置的API，本例中已配置的API为“spring-boot-05-api”，自定义访问前缀。

(4) 参数配置完成后，单击<确定>按钮，API定义完成，如下图所示。

上架API

前提条件

• 服务商已注册TCE PaaS登录帐号，且帐号可正常使用。
• 当前帐号已正确安装API运行环境及组件，当前帐号可正常使用。
• API已经定义完成。

上架API的操作步骤如下所示。

(1) 服务商登录PaaS平台，选择对应的集群项目，点击[API网关/开放API/API管理]菜单项，进入API列表页面。

用户登录时速云官网 https://www.tenxcloud.com/，执行相关操作。

(2) 找到要上一步已经定义完成的API，点击API名称进入详情页面。

(3) 单击<申请上架>按钮，进入上架确认页面，确认上架后，单击<确定>按钮，上架申请提交成功。

备注

API类型资产上架后不可轻易下架，下架后仍不支持编辑，请用户仔细确认后申请上架。

上架审批

申请提交后等待审批结果与沟通即可，请关注工单、电话/邮箱。

查看API

前提条件

• 服务商已注册TCE PaaS帐号，且帐号可正常使用。
• 当前帐号已正确安装API运行环境及组件，当前帐号可正常使用。
• 管理员已完成API资源上架申请审批。

管理员审批后，提交方可收到审批结果通知的邮件，服务商查看提交审批的API资产状态。

(1) 服务商登录PaaS平台，选择对应的集群项目，点击[API网关/开放API/API管理]菜单项，进入API列表页面。

用户登录时速云官网 https://www.tenxcloud.com/，执行相关操作。

(2) 找到提交申请审批的API资源，点击API名称进入详情页面。

(3) 查看已提交上架申请的API资源，API资源状态为“上架售卖”，如下图所示。