From d9e54388e7fde2462e8b7e0165c5e7da3f202593 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期四, 07 七月 2022 19:07:59 +0800
Subject: [PATCH] add 整合 springdoc-openapi-javadoc 基于代码注释生成文档
---
ruoyi-admin/src/main/resources/application.yml | 162 ++++++++++++++++++++++++++---------------------------
1 files changed, 79 insertions(+), 83 deletions(-)
diff --git a/ruoyi-admin/src/main/resources/application.yml b/ruoyi-admin/src/main/resources/application.yml
index cd53e4a..3c11d01 100644
--- a/ruoyi-admin/src/main/resources/application.yml
+++ b/ruoyi-admin/src/main/resources/application.yml
@@ -5,11 +5,13 @@
# 鐗堟湰
version: ${ruoyi-vue-plus.version}
# 鐗堟潈骞翠唤
- copyrightYear: 2021
+ copyrightYear: 2022
# 瀹炰緥婕旂ず寮�鍏�
demoEnabled: true
# 鑾峰彇ip鍦板潃寮�鍏�
addressEnabled: true
+ # 缂撳瓨鎳掑姞杞�
+ cacheLazy: false
captcha:
# 椤甸潰 <鍙傛暟璁剧疆> 鍙紑鍚叧闂� 楠岃瘉鐮佹牎楠�
@@ -51,10 +53,6 @@
org.springframework: warn
config: classpath:logback.xml
-# tlog 鍏ㄥ眬璁块棶鎬ц兘鎷︽埅
-tlog:
- enable-invoke-time-print: true
-
# Spring閰嶇疆
spring:
application:
@@ -77,10 +75,10 @@
restart:
# 鐑儴缃插紑鍏�
enabled: true
- # 涓巚ue鏁村悎閮ㄧ讲浣跨敤
- thymeleaf:
- # 灏嗙郴缁熸ā鏉挎斁缃埌鏈�鍓嶉潰 鍚﹀垯浼氫笌 springboot-admin 椤甸潰鍐茬獊
- template-resolver-order: 1
+ mvc:
+ pathmatch:
+ # 閫傞厤 boot 2.6 璺敱涓� springfox 鍏煎
+ matching-strategy: ANT_PATH_MATCHER
jackson:
# 鏃ユ湡鏍煎紡鍖�
date-format: yyyy-MM-dd HH:mm:ss
@@ -93,41 +91,48 @@
# 鍏佽瀵硅薄蹇界暐json涓笉瀛樺湪鐨勫睘鎬�
fail_on_unknown_properties: false
-# token閰嶇疆
-token:
- # 浠ょ墝鑷畾涔夋爣璇�
- header: Authorization
- # 浠ょ墝瀵嗛挜
- secret: abcdefghijklmnopqrstuvwxyz
- # 浠ょ墝鏈夋晥鏈燂紙榛樿30鍒嗛挓锛�
- expireTime: 30
+# Sa-Token閰嶇疆
+sa-token:
+ # token鍚嶇О (鍚屾椂涔熸槸cookie鍚嶇О)
+ token-name: Authorization
+ # token鏈夋晥鏈� 璁句负涓�澶� (蹇呭畾杩囨湡) 鍗曚綅: 绉�
+ timeout: 86400
+ # token涓存椂鏈夋晥鏈� (鎸囧畾鏃堕棿鏃犳搷浣滃氨杩囨湡) 鍗曚綅: 绉�
+ activity-timeout: 1800
+ # 鏄惁鍏佽鍚屼竴璐﹀彿骞跺彂鐧诲綍 (涓簍rue鏃跺厑璁镐竴璧风櫥褰�, 涓篺alse鏃舵柊鐧诲綍鎸ゆ帀鏃х櫥褰�)
+ is-concurrent: true
+ # 鍦ㄥ浜虹櫥褰曞悓涓�璐﹀彿鏃讹紝鏄惁鍏辩敤涓�涓猼oken (涓簍rue鏃舵墍鏈夌櫥褰曞叡鐢ㄤ竴涓猼oken, 涓篺alse鏃舵瘡娆＄櫥褰曟柊寤轰竴涓猼oken)
+ is-share: false
+ # 鏄惁灏濊瘯浠巋eader閲岃鍙杢oken
+ is-read-head: true
+ # 鏄惁灏濊瘯浠巆ookie閲岃鍙杢oken
+ is-read-cookie: false
+ # token鍓嶇紑
+ token-prefix: "Bearer"
+ # jwt绉橀挜
+ jwt-secret-key: abcdefghijklmnopqrstuvwxyz
+ # 鏄惁杈撳嚭鎿嶄綔鏃ュ織
+ is-log: true
# security閰嶇疆
security:
- # 鐧诲嚭璺緞
- logout-url: /logout
- # 鍖垮悕璺緞
- anonymous:
- - /login
- - /register
- - /captchaImage
+ # 鎺掗櫎璺緞
+ excludes:
+ # 闈欐�佽祫婧�
+ - /*.html
+ - /**/*.html
+ - /**/*.css
+ - /**/*.js
# swagger 鏂囨。閰嶇疆
+ - /favicon.ico
- /doc.html
- - /swagger-resources/**
- - /webjars/**
- - /*/api-docs
+ - /swagger-ui/**
+ - /*/api-docs/**
# druid 鐩戞帶閰嶇疆
- /druid/**
# actuator 鐩戞帶閰嶇疆
- /actuator
- /actuator/**
- # 鐢ㄦ埛鏀捐
- permit-all:
-
-# 閲嶅鎻愪氦
-repeat-submit:
- # 鍏ㄥ眬闂撮殧鏃堕棿(姣)
- interval: 5000
# MyBatisPlus閰嶇疆
# https://baomidou.com/config/
@@ -141,25 +146,15 @@
typeAliasesPackage: com.ruoyi.**.domain
# 鍚姩鏃舵槸鍚︽鏌� MyBatis XML 鏂囦欢鐨勫瓨鍦紝榛樿涓嶆鏌�
checkConfigLocation: false
- # 閫氳繃璇ュ睘鎬у彲鎸囧畾 MyBatis 鐨勬墽琛屽櫒锛孧yBatis 鐨勬墽琛屽櫒鎬诲叡鏈変笁绉嶏細
- # SIMPLE锛氭瘡涓鍙ュ垱寤烘柊鐨勯澶勭悊鍣� REUSE锛氫細澶嶇敤棰勫鐞嗗櫒 BATCH锛氭壒閲忔墽琛屾墍鏈夌殑鏇存柊
- executorType: SIMPLE
configuration:
# 鑷姩椹煎嘲鍛藉悕瑙勫垯锛坈amel case锛夋槧灏�
mapUnderscoreToCamelCase: true
- # 褰撹缃负 true 鐨勬椂鍊欙紝鎳掑姞杞界殑瀵硅薄鍙兘琚换浣曟噿灞炴�у叏閮ㄥ姞杞斤紝鍚﹀垯锛屾瘡涓睘鎬ч兘鎸夐渶鍔犺浇銆傞渶瑕佸拰 lazyLoadingEnabled 涓�璧蜂娇鐢ㄣ��
- aggressiveLazyLoading: true
# MyBatis 鑷姩鏄犲皠绛栫暐
# NONE锛氫笉鍚敤 PARTIAL锛氬彧瀵归潪宓屽 resultMap 鑷姩鏄犲皠 FULL锛氬鎵�鏈� resultMap 鑷姩鏄犲皠
autoMappingBehavior: PARTIAL
# MyBatis 鑷姩鏄犲皠鏃舵湭鐭ュ垪鎴栨湭鐭ュ睘鎬у鐞嗙瓥
# NONE锛氫笉鍋氬鐞� WARNING锛氭墦鍗扮浉鍏宠鍛� FAILING锛氭姏鍑哄紓甯稿拰璇︾粏淇℃伅
autoMappingUnknownColumnBehavior: NONE
- # Mybatis涓�绾х紦瀛橈紝榛樿涓� SESSION
- # SESSION session绾у埆缂撳瓨 STATEMENT 鍏抽棴涓�绾х紦瀛�
- localCacheScope: SESSION
- # 寮�鍚疢ybatis浜岀骇缂撳瓨锛岄粯璁や负 true
- cacheEnabled: false
# 鏇磋缁嗙殑鏃ュ織杈撳嚭 浼氭湁鎬ц兘鎹熻�� org.apache.ibatis.logging.stdout.StdOutImpl
# 鍏抽棴鏃ュ織璁板綍 (鍙崟绾娇鐢� p6spy 鍒嗘瀽) org.apache.ibatis.logging.nologging.NoLoggingImpl
# 榛樿鏃ュ織杈撳嚭 org.apache.ibatis.logging.slf4j.Slf4jImpl
@@ -167,16 +162,10 @@
global-config:
# 鏄惁鎵撳嵃 Logo banner
banner: true
- # 鏄惁鍒濆鍖� SqlRunner
- enableSqlRunner: false
dbConfig:
# 涓婚敭绫诲瀷
# AUTO 鑷 NONE 绌� INPUT 鐢ㄦ埛杈撳叆 ASSIGN_ID 闆姳 ASSIGN_UUID 鍞竴 UUID
- idType: AUTO
- # 琛ㄥ悕鏄惁浣跨敤椹煎嘲杞笅鍒掔嚎鍛藉悕,鍙琛ㄥ悕鐢熸晥
- tableUnderline: true
- # 澶у啓鍛藉悕,瀵硅〃鍚嶅拰瀛楁鍚嶅潎鐢熸晥
- capitalMode: false
+ idType: ASSIGN_ID
# 閫昏緫宸插垹闄ゅ��
logicDeleteValue: 2
# 閫昏緫鏈垹闄ゅ��
@@ -193,26 +182,45 @@
swagger:
# 鏄惁寮�鍚痵wagger
enabled: true
- # 璇锋眰鍓嶇紑
- pathMapping: /dev-api
- # 鏍囬
- title: '鏍囬锛�${ruoyi.name}鍚庡彴绠＄悊绯荤粺_鎺ュ彛鏂囨。'
- # 鎻忚堪
- description: '鎻忚堪锛氱敤浜庣鐞嗛泦鍥㈡棗涓嬪叕鍙哥殑浜哄憳淇℃伅,鍏蜂綋鍖呮嫭XXX,XXX妯″潡...'
- # 鐗堟湰
- version: '鐗堟湰鍙�: ${ruoyi-vue-plus.version}'
- # 浣滆�呬俊鎭�
- contact:
- name: Lion Li
- email: crazylionli@163.com
- url: https://gitee.com/JavaLionLi/RuoYi-Vue-Plus
- groups:
- - name: 1.婕旂ず妗堜緥
- basePackage: com.ruoyi.demo
- - name: 2.绯荤粺妯″潡
- basePackage: com.ruoyi.web
- - name: 3.浠ｇ爜鐢熸垚妯″潡
- basePackage: com.ruoyi.generator
+ info:
+ # 鏍囬
+ title: '鏍囬锛�${ruoyi.name}鍚庡彴绠＄悊绯荤粺_鎺ュ彛鏂囨。'
+ # 鎻忚堪
+ description: '鎻忚堪锛氱敤浜庣鐞嗛泦鍥㈡棗涓嬪叕鍙哥殑浜哄憳淇℃伅,鍏蜂綋鍖呮嫭XXX,XXX妯″潡...'
+ # 鐗堟湰
+ version: '鐗堟湰鍙�: ${ruoyi-vue-plus.version}'
+ # 浣滆�呬俊鎭�
+ contact:
+ name: Lion Li
+ email: crazylionli@163.com
+ url: https://gitee.com/JavaLionLi/RuoYi-Vue-Plus
+ components:
+ # 閴存潈鏂瑰紡閰嶇疆
+ security-schemes:
+ apiKey:
+ type: APIKEY
+ in: HEADER
+ name: ${sa-token.token-name}
+
+springdoc:
+ swagger-ui:
+ # 淇敼Swagger UI璺緞
+ path: /doc.html
+ # 寮�鍚疭wagger UI鐣岄潰
+ enabled: true
+ api-docs:
+ # 淇敼api-docs璺緞
+ path: /v3/api-docs
+ # 寮�鍚痑pi-docs
+ enabled: true
+ #杩欓噷瀹氫箟浜嗕袱涓垎缁勶紝鍙畾涔夊涓紝涔熷彲浠ヤ笉瀹氫箟
+ group-configs:
+ - group: 1.婕旂ず妯″潡
+ packages-to-scan: com.ruoyi.demo
+ - group: 2.绯荤粺妯″潡
+ packages-to-scan: com.ruoyi.web
+ - group: 3.浠ｇ爜鐢熸垚妯″潡
+ packages-to-scan: com.ruoyi.generator
# 闃叉XSS鏀诲嚮
xss:
@@ -227,20 +235,10 @@
thread-pool:
# 鏄惁寮�鍚嚎绋嬫睜
enabled: false
- # 鏍稿績绾跨▼姹犲ぇ灏�
- corePoolSize: 8
- # 鏈�澶у彲鍒涘缓鐨勭嚎绋嬫暟
- maxPoolSize: 16
# 闃熷垪鏈�澶ч暱搴�
queueCapacity: 128
# 绾跨▼姹犵淮鎶ょ嚎绋嬫墍鍏佽鐨勭┖闂叉椂闂�
keepAliveSeconds: 300
- # 绾跨▼姹犲鎷掔粷浠诲姟(鏃犵嚎绋嬪彲鐢�)鐨勫鐞嗙瓥鐣�
- # CALLER_RUNS_POLICY 璋冪敤鏂规墽琛�
- # DISCARD_OLDEST_POLICY 鏀惧純鏈�鏃х殑
- # DISCARD_POLICY 涓㈠純
- # ABORT_POLICY 涓
- rejectedExecutionHandler: CALLER_RUNS_POLICY
--- # redisson 缂撳瓨閰嶇疆
redisson:
@@ -268,8 +266,6 @@
management:
endpoints:
web:
- # Actuator 鎻愪緵鐨� API 鎺ュ彛鐨勬牴鐩綍銆傞粯璁や负 /actuator
- base-path: /actuator
exposure:
# 闇�瑕佸紑鏀剧殑绔偣銆傞粯璁ゅ�煎彧鎵撳紑 health 鍜� info 涓や釜绔偣銆傞�氳繃璁剧疆 * 锛屽彲浠ュ紑鏀炬墍鏈夌鐐广��
# 鐢熶骇鐜涓嶅缓璁斁寮�鎵�鏈� 鏍规嵁椤圭洰闇�姹傛斁寮�鍗冲彲
--
Gitblit v1.9.3