Astro企业应用 AstroPro-如何为对象自定义API:添加自定义API

时间:2025-02-12 15:02:26

添加自定义API

  1. 在业务设计页面,选中某个业务对象。
  2. 单击右侧属性配置中的“自定义API”,进入编辑自定义API页面。
  3. 单击“新增”,按需添加所需的API。

    • 实例级别:定义API实例的级别,如类型、实例。
    • 动作名称:设置API的动作名称。
    • 请求方法:HTTP请求方法(也称为操作或动作),用于告诉服务您正在请求什么类型的操作。
      • get请求服务器返回指定资源。
      • put请求服务器更新指定资源。
      • post请求服务器新增资源或执行特殊操作。
      • delete请求服务器删除指定资源。
    • 请求对象:单击“添加请求对象”,可添加请求对象,即API请求的输入参数。
    • 返回对象:请求发送后,您会收到的响应,如状态码。
    • 路径:单击“输入path”,添加API的路径,格式为变量放到“{}”中,单词用“_”连接,非变量单词用“-”连接。例如:/meta-bo1s/{meta_bo1_id}/test-action。

      当您没有自定义API路径,且“实例级别”选择“实例”时,生成的API路径上会拼接一个{MetaBo}_id的路径,同时方法上会多生成一个当前MetaBo主键的参数,如图2所示。

      图2 API路径
    • 描述:输入自定义API的描述信息。

  4. 设置代码生成层,参数设置与代码生成关系请参考表1

    表1 设置代码生成层组合说明

    接口层

    应用层

    数据访问层

    代码生成

    x

    x

    仅在应用层生成代码。

    x

    x

    仅在数据访问层生成代码。

    x

    在接口层和应用层生成代码。

    x

    在应用层和数据访问层生成代码。

    在接口层、应用层和数据访问层皆生成代码。

    图3 设置代码生成层

  5. 设置完成后,单击“保存”
support.huaweicloud.com/usermanual-astropro/astropro_05_0052.html