From 9e831a1956877fc2d1c65b53beafff979662990c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B7=A1=E8=93=9D=E8=89=B2=E7=9A=84=E5=BF=A7=E4=BC=A4?= <1195465270@qq.com> Date: Fri, 18 Dec 2020 21:01:45 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9Eknife4j-UI=20=E7=99=BB?= =?UTF-8?q?=E5=BD=95=E7=B3=BB=E7=BB=9F=E5=90=8E=E8=AE=BF=E9=97=AEhttp://lo?= =?UTF-8?q?calhost:80/doc.html=E5=8D=B3=E5=8F=AF=EF=BC=8C=E8=BF=99?= =?UTF-8?q?=E4=B8=AAUI=E6=AF=94=E8=BE=83=E5=A5=BD=E7=9C=8B=EF=BC=8C?= =?UTF-8?q?=E8=B0=83=E8=AF=95=E4=B9=9F=E5=BE=88=E6=96=B9=E4=BE=BF=20?= =?UTF-8?q?=E6=9C=89=E5=85=B4=E8=B6=A3=E5=8F=AF=E4=BB=A5=E5=8E=BB=E5=AE=83?= =?UTF-8?q?=E7=9A=84=E5=AE=98=E7=BD=91=E7=9C=8B=E4=B8=8B=EF=BC=9Ahttps://x?= =?UTF-8?q?iaoym.gitee.io/knife4j/documentation/?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pom.xml | 14 +++++ .../core/config/Swagger2Knife4jConfig.java | 61 +++++++++++++++++++ ruoyi-common/pom.xml | 10 +++ 3 files changed, 85 insertions(+) create mode 100644 ruoyi-admin/src/main/java/com/ruoyi/web/core/config/Swagger2Knife4jConfig.java diff --git a/pom.xml b/pom.xml index 2dd1e1e73..eefd8bc16 100644 --- a/pom.xml +++ b/pom.xml @@ -31,6 +31,8 @@ 1.3.3 4.1.2 1.7 + 2.0.5 + 1.9.6 @@ -144,6 +146,18 @@ springfox-swagger-ui ${swagger.version} + + + + com.github.xiaoymin + knife4j-spring-boot-starter + ${knife4j.version} + + + com.github.xiaoymin + swagger-bootstrap-ui + ${swagger.bootstrap.ui.version} + diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/core/config/Swagger2Knife4jConfig.java b/ruoyi-admin/src/main/java/com/ruoyi/web/core/config/Swagger2Knife4jConfig.java new file mode 100644 index 000000000..d02818c35 --- /dev/null +++ b/ruoyi-admin/src/main/java/com/ruoyi/web/core/config/Swagger2Knife4jConfig.java @@ -0,0 +1,61 @@ +package com.ruoyi.web.core.config; + + +import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j; +import com.ruoyi.common.config.RuoYiConfig; +import io.swagger.annotations.ApiOperation; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Import; +import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration; +import springfox.documentation.builders.ApiInfoBuilder; +import springfox.documentation.builders.PathSelectors; +import springfox.documentation.builders.RequestHandlerSelectors; +import springfox.documentation.service.ApiInfo; +import springfox.documentation.service.Contact; +import springfox.documentation.spi.DocumentationType; +import springfox.documentation.spring.web.plugins.Docket; +import springfox.documentation.swagger2.annotations.EnableSwagger2; + +/** + * @Description swagger2Knife4j + * @Author liuwy + * @Date 2020/12/18 + */ +@Configuration +@EnableSwagger2 +@EnableKnife4j +@Import(BeanValidatorPluginsConfiguration.class) +public class Swagger2Knife4jConfig { + + @Bean(value = "adminApi") + public Docket createRestApi() { + Docket docket=new Docket(DocumentationType.SWAGGER_2) + .enable(true) + .apiInfo(apiInfo()) + //分组名称 + .groupName("若依") + .select() + //扫描所有有注解的api,用这种方式更灵活 + .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) + .paths(PathSelectors.any()) + .build(); + return docket; + } + + private ApiInfo apiInfo() { + return new ApiInfoBuilder() + //标题 + .title("标题:若依管理系统_接口文档") + //描述 + .description("描述:用于管理集团旗下公司的人员信息,具体包括XXX,XXX模块...") + //作者 + .contact(new Contact(RuoYiConfig.getName(), null, null)) + //服务url + .termsOfServiceUrl("http://ruoyi.vip") + //版本号 + .version("版本号:" + RuoYiConfig.getVersion()) + .build(); + } + +} diff --git a/ruoyi-common/pom.xml b/ruoyi-common/pom.xml index b5e84fabc..1f71db68c 100644 --- a/ruoyi-common/pom.xml +++ b/ruoyi-common/pom.xml @@ -71,6 +71,16 @@ fastjson + + + com.github.xiaoymin + knife4j-spring-boot-starter + + + com.github.xiaoymin + swagger-bootstrap-ui + + commons-io