doc-apis 配置项

doc-apis:
  enable: true #是否开启自动生成接口,默认开启
  projectName: easy-es # 项目名称,填你的项目名称,用于生成的接口文档界面展示
  projectPath: E:\\easy-es\\sample # 项目路径,填你的项目路径,生成时扫描的目录,默认为当前项目路径, controller分散在多个子模块的项目可以用逗号隔开
  docVersion: 1.0.0 # 生成接口文档的版本号
  docPath: E:\\tmp # 生成的文档路径,例如我想把生成的文档放在E盘tmp文件夹下 ,不配置则默认在当前工程目录下生成
  autoGenerate: true # 是否自动生成 默认为true 若为false时,需要加@DocApi注解 可用最细粒度于控制生成的接口
  generateMarkDown: true # 是否生成markdown文档 默认为true, 为false则仅生成html接口文档
  watermark: doc-apis # 水印,默认值为doc-apis
  classificationLevel: Ⅱ # 密级 默认为Ⅱ Ⅰ:绝密 Ⅱ:机密 Ⅲ:秘密 Ⅳ:普通 此字段支持字符串,亦可直接写中文
  locale: Locale.CHINESE # 生成文档的语言,默认为当前系统默认语言,当前已支持中文和英文接口文档,已实现i18n,理论未来可支持各种主流语言
  corsConfig:
    allowCors: true # 是否允许跨域, 默认值为true,因为本地Html直接访问后端服务是无法跨域的,所以默认开启跨域,若需要关闭跨域,请配置allowCors为false即可
    maxAge: 3600 # 允许跨域时间,默认值为3600s
    pathPattern: /** # 允许跨域请求的域名, 默认值为/**
    allowedOriginPatterns: * # 允许跨域的来用模式 默认值为 *
    allowedMethods: * # 允许跨域请求的方法, 默认值为*
    allowedHeaders: * # 跨域允许请求头, 默认值为* 
    allowCredentials: true # 是否允许证书,默认值为true

提示

以上所有配置,仅针对Springboot项目,并且均有默认值,理论上不需要配置,除非个别特殊场景需要自定义,按需配置即可,非springboot涉及如上配置,直接在生成工具类中配置DocsConfig对象即可,可参考前一章节.