# 应用API管理

支持为低代码平台管理员和租户管理员提供API管理功能,使其可以管理本平台导出的API接口和使用其他低代码平台的API接口或第三方API接口。

# 功能说明

应用API管理中包括如下两类应用:

  • 平台API应用:由平台应用导出接口生成,不支持编辑和删除。

    • 平台API应用生命周期与应用的生命周期一致,可以通过在IDE页面修改API接口并重新发布进行API接口的更新。

    • 删除应用时,导出的平台API应用也随之删除。

  • 第三方API应用:由管理员手动创建生成,支持编辑和删除。

# 平台API应用

# 导出平台应用接口

全局逻辑支持导出为API接口,具体操作步骤如下:

  1. 右键单击对应的全局逻辑,在弹出框中单击导出为接口

    image-20230112105641038

  2. 在弹窗中编辑接口名称,请求方法等信息,完成编辑后单击下一步按钮。

    • GET :向指定的URL请求资源,可携带参数(明文)。
    • POST :向指定的URL提交资源,表单数据提交,数据进行封装(比Get方法安全)。
    • PUT :与POST类似,通常用于对资源数据的更新修改。
    • DELETE :删除指定的资源。

    image-20230112110357373

  3. 编辑入参请求类型,完成修改后单击导出按钮。

    image-20230112110533297

  4. 发布应用,完成发布后导出的API接口会显示在对应的API应用中。

    image-20230112111012304

# 第三方API应用

# 创建第三方API应用

  1. 集成中心 -> 应用API管理页面,单击创建应用按钮。

    image-20230111160140983

  2. 在弹窗中编辑应用信息,单击创建按钮完成API应用创建。

    • 应用类型:支持HTTP和HTTPS协议。
    • 应用名称:应用名称,支持字母、中文、数字、下划线、中划线或.组成。
    • 应用标识:应用的唯一标识,支持字母、数字和下划线,需以字母开头。
    • 应用地址:API的访问地址,需与应用类型保持一致,如HTTP应用格式需为http://xxx。
    • 应用描述:应用的自定义说明。

    image-20230111160758613

# 应用详情

应用详情页可对第三方API应用信息进行修改或删除,支持查看基本信息或进行API管理操作。

# 修改应用
  1. 单击修改按钮。

    image-20230112114258537

  2. 在弹窗中编辑应用信息,单击确定按钮完成修改。

    应用名称与应用标识不支持修改。

    image-20230112114400400

# 删除应用
  1. 单击删除按钮。

    image-20230112114739892

  2. 在弹窗中进行二次确认,确认无误后单击确定按钮。

    image-20230112114851612

# 基本信息
  • 基本信息:包含应用名称、应用类型、应用标识、开发环境应用地址、生产环境应用地址、应用描述等信息。
  • 自动导入接口:支持导入Swagger2.0版本以上的接口文档。

image-20230112112905480

# API管理

API管理选项卡中包含数据接口和数据模型两个模块。

image-20230112145848987

  • 数据接口:支持创建、编辑或删除API接口。单击接口名称可进入接口详情页,支持查看及编辑详细信息、请求信息、响应信息三个模块。

    • 详细信息:包含接口名称、所属应用、风格类型、接口标识、描述信息、请求URL等信息。
    • 请求信息:包含Request Url、Request Path、Query String、Request Header等信息。
    • 响应信息:包含Response Header、Response Body等信息。

    image-20230112150712597

  • 数据模型:支持创建、编辑或删除数据模块。单击数据模型名称可进入数据模型详情页,支持查看模型基本信息、编辑属性列表。

    image-20230112150648149

# 使用指导

# get接口支持formdata格式

当请求header中存在Content-Type:application/x-www-form-urlencoded时,入参转换为form表单处理,用户使用界面不需要调整,操作步骤如下:

  1. 进入接口详情页请求信息栏目下,单击修改链接。

    image-20230112152934836

  2. 编辑Request Header,添加一个请求头,名称选择Content-Type默认值填入application/x-www-form-urlencoded。完成编辑后单击保存按钮。

    image-20230112153757721

上次更新: 2023年06月14日