chore: 完善配置文件部分配置说明

continew-webapi/src/main/resources/config/application-dev.yml

@@ -134,6 +134,7 @@ captcha:
     templateId: 1
 
 --- ### 日志配置
+## API 请求/响应日志配置
 continew-starter.log:
   # 是否打印日志，开启后可打印访问日志（类似于 Nginx access log）
   is-print: true
@@ -170,34 +171,36 @@ continew-starter.messaging.websocket:
   allowed-origins: '*'
 
 --- ### 短信配置
+# 配置文件方式和 [短信配置] 功能可任选其一方式使用，也可共同使用，但实际开发时建议选择一种，注释或删除另一方
 sms:
-  # 从 YAML 读取配置
-  config-type: YAML
   http-log: true
   is-print: false
-  blends:
+#  # 从 YAML 读取配置
-    cloopen:
+#  config-type: YAML
-      # 短信厂商
+#  blends:
-      supplier: cloopen
+#    cloopen:
-      base-url: https://app.cloopen.com:8883/2013-12-26
+#      # 短信厂商
-      access-key-id: 你的Access Key
+#      supplier: cloopen
-      access-key-secret: 你的Access Key Secret
+#      base-url: https://app.cloopen.com:8883/2013-12-26
-      sdk-app-id: 你的应用ID
+#      access-key-id: 你的Access Key
+#      access-key-secret: 你的Secret Key
+#      sdk-app-id: 你的应用ID
 
 --- ### 邮件配置
-spring.mail:
+# 配置文件方式和 [邮件配置] 功能可任选其一方式使用，实际开发时请注释或删除另一方
-  # 根据需要更换
+#spring.mail:
-  host: smtp.126.com
+#  # 根据需要更换
-  port: 465
+#  host: smtp.126.com
-  username: 你的邮箱
+#  port: 465
-  password: 你的邮箱授权码
+#  username: 你的邮箱
-  properties:
+#  password: 你的邮箱授权码
-    mail:
+#  properties:
-      smtp:
+#    mail:
-        auth: true
+#      smtp:
-        socketFactory:
+#        auth: true
-          class: javax.net.ssl.SSLSocketFactory
+#        socketFactory:
-          port: 465
+#          class: javax.net.ssl.SSLSocketFactory
+#          port: 465
 
 --- ### Just Auth 配置
 justauth:

continew-webapi/src/main/resources/config/application-prod.yml

@@ -136,6 +136,7 @@ captcha:
     templateId: 1
 
 --- ### 日志配置
+## API 请求/响应日志配置
 continew-starter.log:
   # 是否打印日志，开启后可打印访问日志（类似于 Nginx access log）
   is-print: false
@@ -175,33 +176,35 @@ continew-starter.messaging.websocket:
     - ${project.url}
 
 --- ### 短信配置
+# 配置文件方式和 [短信配置] 功能可任选其一方式使用，也可共同使用，但实际开发时建议选择一种，注释或删除另一方
 sms:
-  # 从 YAML 读取配置
-  config-type: YAML
   is-print: false
-  blends:
+#  # 从 YAML 读取配置
-    cloopen:
+#  config-type: YAML
-      # 短信厂商
+#  blends:
-      supplier: cloopen
+#    cloopen:
-      base-url: https://app.cloopen.com:8883/2013-12-26
+#      # 短信厂商
-      access-key-id: 你的Access Key
+#      supplier: cloopen
-      access-key-secret: 你的Access Key Secret
+#      base-url: https://app.cloopen.com:8883/2013-12-26
-      sdk-app-id: 你的应用ID
+#      access-key-id: 你的Access Key
+#      access-key-secret: 你的Secret Key
+#      sdk-app-id: 你的应用ID
 
 --- ### 邮件配置
-spring.mail:
+# 配置文件方式和 [邮件配置] 功能可任选其一方式使用，实际开发时请注释或删除另一方
-  # 根据需要更换
+#spring.mail:
-  host: smtp.126.com
+#  # 根据需要更换
-  port: 465
+#  host: smtp.126.com
-  username: 你的邮箱
+#  port: 465
-  password: 你的邮箱授权码
+#  username: 你的邮箱
-  properties:
+#  password: 你的邮箱授权码
-    mail:
+#  properties:
-      smtp:
+#    mail:
-        auth: true
+#      smtp:
-        socketFactory:
+#        auth: true
-          class: javax.net.ssl.SSLSocketFactory
+#        socketFactory:
-          port: 465
+#          class: javax.net.ssl.SSLSocketFactory
+#          port: 465
 
 --- ### Just Auth 配置
 justauth:

continew-webapi/src/main/resources/config/application.yml

@@ -21,8 +21,9 @@ project:
     url: https://github.com/continew-org/continew-admin/blob/dev/LICENSE
 
 --- ### 日志配置
+## API 请求/响应日志配置
 continew-starter.log:
-  # 包含信息
+  # 记录信息
   includes:
     - DESCRIPTION
     - MODULE