属性配置

配置语言国际化,日志等,

TIP

默认不用配置任何参数。会使用默认的，配置了会使用你项目中的配置。

默认配置

yml

rest-api:
  enabled: false
  msg: msg
  code: code
  code-success-value: OK
  success: success
  previousPage: previousPage
  nextPage: nextPage
  pageSize: pageSize
  hasNext: hasNext
  totalPageSize: totalPageSize
  pageWrap: true
  pageData: pageData
  data: data
  include-packages: cn.soboys.superaide.controller
  exclude-packages: xx.xxx.xxx
  jwt:
    secret: 123456 # 秘钥 建议加密后秘钥如md5 不要使用明文长度大于6位
    expiration: 86400 # token 过期时间（单位秒 1天后过期）
    token-header: Token #header token 名称
    remember-me-expiration: 604800 #记住我 token过期时间(单位秒 7天后过期)
    user-sign: true # 是否自定义签名。为true需要实现加密接口。和 配置 jwtCfg注入对应bean
    authorization:
      has-authorization: true
      includes-url: /user # 需要认证请求 多个用逗号隔开
      excludes-url: /login,/register/** # 配置无需认证的
  redis:
    key-prefix: rest
  rest-api:
  json:
    number-form: ".00" # 浮点数格式化  ,000,00 不足补零。,###.## 不会补零 （四舍五入）
    date-form: yyyy-MM-dd HH:mm:ss.SSS #时间格式化  timestamp 时间戳
    null-able: # 对空返回处理
      has-null-able: false # 默认不处理   original 类型代表单个不做任何处理
      number-type: number # 处理number 空返回 "0"
      array-type: array # 处理集合空返回 []
      double-type: double # 处理double 类型空返回 "0.00"
  ip2region:
    external: false
    location: classpath:ip2region/ip2region.xdb
  openapi:
    description:
    title:
    version:
    license:
    contact:
      name:
      email:
      url:
  logging:
    path: ./logs #日志存储路径（服务器上绝对）
    max-history: 90 # 保存多少天
    max-file-size: 3MB # 每个文件大小
    max-total-size-cap: 1GB #总文件大小超过多少压缩
    level-root: INFO # 这里的INFO可以替换为其他日志等级，如DEBUG, WARN, ERROR, TRACE, FATAL, OFF等。 日志等级由低到高分别是debugger-info-warn-error
    logDataSourceClass: cn.soboys.restapispringbootstarter.log.LogFileDefaultDataSource # 日志数据源
  i18n:
    # 若前端无header传参则返回中文信息
    i18n-header: Lang
    default-lang: cn
    message:
      # admin
      internal_server_error:
        en: Internal Server Error
        cn: 系统错误
      bad_gateway:
        en: Bad Gateway
        cn: 错误的请求
      unauthorized:
        en: Unauthorized
        cn: 未授权
      forbidden:
        en: Forbidden
        cn: 资源禁止访问
      method_not_allowed:
        en: Method Not Allowed
        cn: 方法不被允许
      request_timeout:
        en: Request Timeout
        cn: 请求超时
      invalid_argument:
        en: Invalid Argument {}
        cn: 参数错误 {}
      argument_analyze:
        en: Argument Analyze {}
        cn: 参数解析异常 {}
      business_exception:
        en: Business Exception
        cn: 业务错误
      not_found:
        en: Not Found
        cn: 请求资源不存在

代码生成配置

支持MybatisPlus代码一键生成默认不引入MybatisPlus生成依赖需要手动引入

java

package cn.soboys.restapispringbootstarter.config;

import lombok.Data;

/**
 * @author 公众号 程序员三时
 * @version 1.0
 * @date 2023/7/5 00:05
 * @webSite https://github.com/coder-amiao
 */
@Data
public class GenerateCodeConfig {
    /**
     * 数据库驱动
     */
    private String driverName;
    /**
     * 数据库连接用户名
     */
    private String username;
    /**
     * 数据库连接密码
     */
    private String password;
    /**
     * 数据库连接url
     */
    private String url;
    /**
     * 生成代码 保存路径。默认当前项目下。
     * 如需修改，使用觉得路径
     */
    private String projectPath;
    /**
     * 代码生成包位置
     */
    private String packages;
}

属性配置 ​

默认配置 ​

代码生成配置 ​

属性配置

默认配置

代码生成配置