# API 应用

# 创建菜单

系统默认创建的是菜单;如果希望创建菜单目录,可以选中“生成代码”的“否”选项; 创建菜单

  • 所属父类:选择上级菜单,如果是最顶级,则不需要选择
  • 菜单名称:显示在侧栏,仪表盘页面,顶部菜单的名称
  • 控制器名称:定义此菜单对应的模块和控制器名,比如Raise/Employee,表示在目录Raise目录下
  • 生成代码:是否生成前后端代码
  • 创建数据表:是否允许创建数据库表,一般是系统中已经存在此数据库表的时候选择否
  • 选择链接库:选择创建数据库表的数据库链接,不同的链接对应不同的服务器
  • 数据表名: 数据库表名,推荐按照系统默认的表名创建表
  • 主键ID: 数据库表的主键,推荐按照系统默认的主键创建表

# 字段管理

# 字段类型

参考 管理字段

# 创建字段

img_2.png

  • 字段标题:数据库表的字段注释,表单的标签名,数据表的列名
  • 字段名称:数据库表字段名,表单的变量名,数据表的绑定变量名
  • 字段类型,系统默认支持字段类型
  • 更新字段:是否在表中修改对应字段
  • 可录入:是否在添加和修改接口中包含此字段
  • 表单验证:数据库表的列定义的非空和唯一的约束
  • 验证码规则:表单的验证规则,是预定义的正则表达式
  • 数据结构:创建的数据库中表的字段的数据类型
  • 字段长度:创建的数据库字段的长度
  • 字段索引:为此字段创建索引,建议对经常需要查询的字段配置索引以提高性能

###字段选项 与后台应用菜单的字段管理类似,只是不会包含对前端视图相关的属性的设置。

  • 显示状态:查询接口是否返回此字段数据
  • 录入状态:添加接口是否提交此字段数据
  • 搜索类型:同后台字段,支持不搜索,精确搜索,模糊搜索

# 方法管理

# 方法类型

参考 管理方法

# 创建方法

img_3.png

  • 方法类型:参见系统支持的方法
  • 方法名称:按钮的名称
  • 英文名称:方法对应的控制器内的方法名称
  • 操作字段:自定义此方法中需要操作的字段

# 方法选项

api 接口方法可以设置验证方法和缓存;

  • Token 验证: 开启后,此接口需要通过传递token确认身份,否则访问失败
  • 短信验证: 开启后,此接口必须提供短信验证码才能访问,否则访问失败
  • 图片验证:开启后,此接口必须提供验证码才能访问,否则访问失败
  • 缓存时间:开启缓存,服务器会自动缓存查询结果,缓存到期后,再次查询