springBoot整合SwaggerUI 更友好的页面ui体现swagger-bootstrap-ui

最新推荐文章于 2024-08-07 22:06:03 发布

少年ing

最新推荐文章于 2024-08-07 22:06:03 发布

阅读量834

点赞数

CC 4.0 BY-SA版权

分类专栏： SpringBoot

本文链接：https://blog.youkuaiyun.com/weixin_35815479/article/details/99963359

先看效果

之前版本http://localhost:8082/swagger-ui.html

新版本访问地址 http://localhost:8082/doc.html

1: 通过idea创建springBoot项目此处只记录下springBoot项目整合swagger 通过idea创建springBoot项目暂不演示

2：在pom.xml 中添加swagger依赖

 <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
  </dependency>
   <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.7.0</version>
    </dependency>

  <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>swagger-bootstrap-ui</artifactId>
      <version>1.8.9</version>
  </dependency>

3.创建Swagger2配置类

package com.chinacoal.microservice.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {


    private ApiInfo apiInfo(String name, String description, String version) {
        return new ApiInfoBuilder().title(name).description(description).version(version).build();
    }
 //指定controller位置
    @Bean
    public Docket attachment() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo("admin-api", "系统管理员", "1.0"))
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.chinacoal.microservice.impl.controller"))
                .paths(PathSelectors.any())
                .build()
                .groupName("附件管理")
                .pathMapping("/");
    }

}

4.Swagger使用的注解及其说明：

package com.chinacoal.microservice.api;

import com.chinacoal.microservice.model.attachment.CcmsAttList;
import com.chinacoal.microservice.util.result.Result;
import com.primeton.ptp.tarest.core.api.annotation.TarestOperation;
import com.primeton.ptp.tarest.core.api.annotation.TarestService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.