fix 修复swagger开关无法控制关闭问题

疯狂的狮子li

2021-05-17 c4eb641d9c2facb880895b1fa7937415829735b2

fix 修复swagger开关无法控制关闭问题

 .editorconfig

¶Ô±ÈÐÂÎļþ
@@ -0,0 +1,21 @@
# http://editorconfig.org
root = true

# ç©ºæ ¼æ›¿ä»£Tab缩进在各种编辑工具下效果一致
[*]
indent_style = space
indent_size = 4
charset = utf-8
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true

[*.java]
indent_style = tab

[*.{json,yml}]
indent_size = 2

[*.md]
insert_final_newline = false
trim_trailing_whitespace = false

 ruoyi-admin/src/main/resources/application.yml

@@ -193,6 +193,11 @@
  description: '描述：用于管理集团旗下公司的人员信息,具体包括XXX,XXX模块...'
  # ç‰ˆæœ¬
  version: '版本号: ${ruoyi-vue-plus.version}'
  # ä½œè€…信息
  contact:
    name: Lion Li
    email: crazylionli@163.com
    url: https://gitee.com/JavaLionLi/RuoYi-Vue-Plus

# é˜²æ­¢XSS攻击
xss:

 ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java

@@ -1,12 +1,9 @@
package com.ruoyi.framework.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import com.ruoyi.common.config.RuoYiConfig;
import com.ruoyi.framework.config.properties.SwaggerProperties;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
@@ -29,32 +26,10 @@
@Configuration
@EnableSwagger2
@EnableKnife4j
@ConditionalOnClass({Docket.class, ApiInfoBuilder.class})
@ConditionalOnProperty(prefix = "swagger", value = "enable", matchIfMissing = true)
public class SwaggerConfig {
    /**
     * ç³»ç»ŸåŸºç¡€é…ç½®
     */

    @Autowired
    private RuoYiConfig ruoyiConfig;

    /**
     * æ ‡é¢˜
     */
    @Value("${swagger.title}")
    private String title;

    /**
     * æè¿°
     */
    @Value("${swagger.description}")
    private String description;

    /**
     * ç‰ˆæœ¬
     */
    @Value("${swagger.version}")
    private String version;
    private SwaggerProperties swaggerProperties;

    /**
     * åˆ›å»ºAPI
@@ -62,6 +37,7 @@
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
            .enable(swaggerProperties.getEnabled())
                // ç”¨æ¥åˆ›å»ºè¯¥API的基本信息，展示在文档的页面中（自定义展示的信息）
                .apiInfo(apiInfo())
                // è®¾ç½®å“ªäº›æŽ¥å£æš´éœ²ç»™Swagger展示
@@ -117,15 +93,16 @@
     */
    private ApiInfo apiInfo() {
        // ç”¨ApiInfoBuilder进行定制
        SwaggerProperties.Contact contact = swaggerProperties.getContact();
        return new ApiInfoBuilder()
                // è®¾ç½®æ ‡é¢˜
                .title(title)
            .title(swaggerProperties.getTitle())
                // æè¿°
                .description(description)
            .description(swaggerProperties.getDescription())
                // ä½œè€…信息
                .contact(new Contact(ruoyiConfig.getName(), null, null))
            .contact(new Contact(contact.getName(), contact.getUrl(), contact.getEmail()))
                // ç‰ˆæœ¬
                .version(version)
            .version(swaggerProperties.getVersion())
                .build();
    }
}

 ruoyi-framework/src/main/java/com/ruoyi/framework/config/properties/SwaggerProperties.java

@@ -2,7 +2,6 @@

import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@@ -33,4 +32,28 @@
     */
    private String version;

    /**
     * è”系方式
     */
    private Contact contact;

    @Data
    @NoArgsConstructor
    public static class Contact{

        /**
         * è”系人
         **/
        private String name;
        /**
         * è”系人url
         **/
        private String url;
        /**
         * è”系人email
         **/
        private String email;

    }

}