自定义API功能介绍
自定义API页面如图1所示。
选项含义：
- 实例级别：定义API实例的级别，如类型、实例。
- 动作名称：设置API的动作名称。对应到代码中即接口的方法名称。
- 请求方法：HTTP请求方法（也称为操作或动作），用于指定请求的操作类型。
- get：请求服务器返回指定资源。
- put：请求服务器更新指定资源。
- post：请求服务器新增资源或执行特殊操作。
- delete：请求服务器删除指定资源。
- 请求对象：单击“添加请求对象”，可添加请求对象，即API请求的输入参数。如果接口没有入参，此处可以不设置。具体参考请求对象。
- 返回对象：接口的返回值，如果接口没有返回值，此处可以不设置。具体参考返回对象。
- 路径：单击“输入path”，添加API的路径，格式为变量放到“{}”中，单词用“_”连接，非变量单词用“-”连接。例如：/{业务对象类型名}s/{对象id}/test-action。
- 描述：接口的作用。
- 接口层、应用层和数据访问层的多选框：对应自定义API的生成位置， 详情可参考表1。
表1 不同目录结构下实际影响代码路径说明 目录结构
接口层
应用层
数据访问层
DDD
{package}.api.xxx
{package}.app.xxx
{package}.infrastructure.repository.base.xxx
Single
{package}.api.xxx
{package}.service.xxx
{package}.repository.base.xxx
base/service
{package}.api.xxx
{package}.service.xxx
{package}.repository.base.xxx
package为创建服务时定义的打包路径。
请求对象
选项含义：
- 名称：请求参数的名称。
- 参数类型：请求参数的类型，详细描述请参考表2。
- 参数位置：请求参数的位置。
- query：查询字符串参数，位于 URL 的问号（?）之后，以键值对形式出现，多个键值对之间用与号（&）分隔。
- path：路径参数，嵌入在 URL 路径中的参数，用于标识特定资源。
- header：请求头参数，包含在 HTTP 请求头中的参数，用于传递关于请求的附加信息，如身份验证信息、客户端信息等。
- body：请求体参数，向服务器提交大量数据或复杂结构的数据时使用。
- formdata：文件参数类型时使用。
- 必选：控制参数是否必传。
- 描述：参数的描述信息。
表2 请求对象参数说明 参数类型
详细类型
对应JAVA类型
可用参数位置
备注
简单类型
STRING
String
- query
- path
- header
-
BOOLEAN
Boolean
- query
- path
- header
-
INTEGER
Integer
- query
- path
- header
-
LONG
Long
- query
- path
- header
-
DECIMAL
BigDeciaml
- query
- path
- header
-
FLOAT
Float
- query
- path
- header
-
TEXT
String
- query
- path
- header
-
LONG_TEXT
String
- query
- path
- header
-
MEDIUM_TEXT
String
- query
- path
- header
-
DATE
Date
- query
- path
- header
-
DATETIME
Date
- query
- path
- header
-
BYTE
byte[]
- query
- path
- header
-
CURRENCY
BigDeciaml
- query
- path
- header
-
URL
String
- query
- path
- header
-
对象类型
业务对象（BO）类型
业务对象类型
body
eg：Order
列表类型
简单类型列表
List<简单类型>
body
eg：List<String>
业务对象（BO）类型
List<业务对象>
body
eg：List<Order>
返回对象
选项含义：
- 返回码：接口响应的状态码。
- 参数类型：接口返回值的数据类型，详细描述请看下表。
- 描述：接口返回值的描述。
表3 返回对象参数说明 参数类型
详细类型
对应JAVA类型
备注
简单类型
STRING
String
-
BOOLEAN
Boolean
-
INTEGER
Integer
-
LONG
Long
-
DECIMAL
BigDeciaml
-
FLOAT
Float
-
TEXT
String
-
LONG_TEXT
String
-
MEDIUM_TEXT
String
-
DATE
Date
-
DATETIME
Date
-
BYTE
byte[]
-
CURRENCY
BigDeciaml
-
URL
String
-
对象类型
业务对象（BO）类型
业务对象
eg：Order
列表类型
简单类型列表
List<简单类型>
eg：List<String>
业务对象（BO）类型
List<业务对象>
eg：List<Order>
文件类型
FILE
MultipartFile
-
分页参数
业务对象（BO）类型
com.github.pagehelper.PageInfo<业务对象>
-
