请求

请求既是 Http 访问的资源,又是写着业务逻辑的 Java 方法。

请求定义

请求包括:请求地址、请求方法、请求参数和请求返回

请求地址

请求地址的格式为:域名/模块名/服务名/请求名,注意系统生成的请求地址中的服务名和请求名都是小写的

请求方法

请求方法见下表,根据请求动作选择

请求方法 说明
GET 通过请求 URI 得到资源
POST 添加新的内容
PUT 修改某个内容
DELETE 删除某个内容
PATCH 部分文档更改

请求参数

分为两种:传入的参数和系统内置参数。

传入的参数包括如下的属性

属性 说明
参数名称 调用时的参数名
数据类型 包括字符串、整形、日期等基本类型;也包括在数据中定义的数据集
集合 选中表示传入的参数是数组
传参方式 包括请求参数、请求体、请求头和路径参数。一般情况下,使用GET方法设置为请求参数,使用POST方法设置为请求体
必填 选中则调用时必须传入,否则报错
默认值 未传入该参数,则使用默认值作为参数值

系统内置参数有3个:当前用户ID、当前用户名和授权管理中设置的控制范围。这3个参数不需要从调用方传入(是出于安全的考虑),而是在经过网关时,由系统自动施加。

处理逻辑

支持画代码和写代码

请求返回

请求执行后,返回给调用方的数据

属性 说明
数据类型 包括字符串、整形、日期等基本类型;也包括在数据中定义的数据集;还包括无返回
集合 选中表示返回的数据是数组

生成 Java 方法

请求生成的 Java 方法包括方法名及参数、方法体和返回数据

  • 方法名

方法名即为请求名

  • 参数

在请求中定义的参数即为方法的参数。数据类型对应关系如下

参数数据类型 Java 数据类型
字符串 String
整形 Integer
长整形 Long
含小数点数字 Double
精确数字 Decimal
是否 Boolean
日期、时间、日期时间 Date
数据集 数据集Class

选中集合就是 List,例如 List\

  • 方法体

服务采用 SpringBoot 框架,在 service 中调用 mapper,实现业务逻辑。

  • 返回数据

返回基本类型和数据集类型的对应关系,见上表。下面列出几种常用返回值

Java 方法返回值 请求返回
void 无返回
要返回 JSON 对象,转成 String 返回 字符串,调用方可将接收到的返回值序列化为 JSON 对象
List<> 集合,调用方接收到数组

新建请求

在服务上点击“新建请求”,如下图所示,弹出新建请求对话框

1739418623626

输入显示名称(可中文)和请求名称(英文)即可创建一个请求

1739418895333

选择请求方法、输入请求参数、选择采用画代码还是写代码,设置请求返回,注意请求路径是全小写的,如下图所示

1739419027000

results matching ""

    No results matching ""