REST接口说明文档
-
登录说明
处于安全考虑部分接口需要先登录获取授权TOKEN信息才能调用接口功能,需要认证信息的接口请参见每个接口的详细说明。
-
注销说明
用户退出登录统一接口:/logout,无需参数,POST请求
-
安全认证
需要安全认证的接口需要在请求头设置认证信息,格式如下:
参数:Authorization
参数值: Bearer+空格+登录获取TOKEN
-
表格分页参数
对于返回列表数据接口由于涉及到分页信息,需要传递分页参数,格式如下:
参数:pageNum 参数值:当前页码
参数:pageSize 参数值:每页数据条数
-
表格排序说明
对于需要排序的列表,需要传递排序参数,格式如下:
参数:orderByColumn
参数值:数据库表字段+空格+排序方式(asc或者desc)
如果需要多个字段排序请用英文逗号隔开
-
系统字典
对于某些接口查询参数或者返回字段涉及到类型或者状态的可能需要使用到系统字典,调用系统字典接口通过类型可以获取到字典码和字典值。 目前系统提供字典如下:
字典名称 字典类型 字典值 字典码 广告类型 adv_type 主页轮播 2 广告类型 adv_type 引导页轮播 1 用户性别 sys_user_sex 男 0 用户性别 sys_user_sex 女 1 系统是否 sys_yes_no 否 N 系统是否 sys_yes_no 是 Y