ASTRO轻应用 ASTROZERO-配置API:操作步骤

时间:2024-04-25 15:58:40

操作步骤

  1. 登录AstroZero服务控制台。
  2. 在实例页面,单击“进入首页”,进入新版应用开发页面。
  3. 在左侧导航栏中,单击“资产”,进入资产页面。
  4. 将鼠标放在已创建的Native Service上,单击,选择“编辑”
  5. 在NativeService配置页面,选择“导航”。
  6. 在“API设计”页签,单击“开始设计API”。

    图1 开始设计API

  7. 选择“使用模板”,配置基本信息和新URL对应的版本号,单击“创建”。

    图2 创建一个新版本
    • openApi版本:接口定义需要符合openApi规范,这里配置具体openApi的版本号。
    • 选择模板:选择系统预置的模板。
    • 版本:输入服务版本号。
    • 标题:原生服务API的名称。

  8. 创建完成后,单击“新增资源”。
  9. 在“增加资源及操作方法”页面,配置相关参数,单击“确认”。

    图3 增加资源及操作方法配置页面
    • 输入一个新的资源路径(以/开头):与镜像文件中的接口路径保持一致。
    • 方法:调用的方法,如GET(查询)、PUT(增加)、POST(修改)、DELETE(删除)、PATCH(对资源进行部分修改)。
    • 操作名称:与镜像文件中的操作名称保持一致。
    • 公共接口:若勾选,则只能在公共接口中调用,无法在服务编排和脚本中使用。
    • 内容类型:当勾选“公共接口”时,您需要配置内容类型,即请求中的body类型。其中,“application/x-www-form-urlencoded”、“application/xml”、“multipart/form-data”、“text/html”和“text/plain”用于文件上传接口,选择该内容类型,只能调用post类型的方法。
    • 描述:描述信息。

  10. 单击生成的方法,可以在右侧编辑方法的URL、Header、Response参数,需要和镜像文件中接口的URL参数、Header参数、请求参数、返回参数保持一致。编辑参数后,需要单击参数操作列的,再单击“保存”。

    您可参考界面上“/case”、“/case/{CaseId}”两个示例编辑生成的方法。每个方法都需要定义Response参数,否则会部署失败。返回体数据结构在模式对象中定义。

    当Body参数和Response参数较多,一些参数可以封装成对象类型的参数,并在“模式对象”页签设置该类型参数,注意“模式对象”页签中参数名与操作中URL参数不能同名。

    支持按照操作名称和资源路径单,过滤或组合过滤搜索方法。

    图4 编辑方法
    图5 定义模式对象

  11. 参考8~10,新增其他API方法。
  12. 编辑方法完成后,需要手动删除“/case”、“/case/{CaseId}”两个示例,删除示例模式对象。
  13. 单击“保存”,创建的自定义接口会出现在页面上。

    在页面右上方,单击,可以查看自定义接口中的方法和模型对象。单击,可导出该原生服务下接口定义yaml文件。

  14. 单击,发布API。

    发布后如果需要修改API,需要单击,取消发布后进行修改,修改后再保存并发布。

    已发布的API可能在服务编排中已经使用,如果修改API导致不兼容,请同步修改引用该API的服务编排。

support.huaweicloud.com/usermanual-astrozero/astrozero_05_9265.html