SpringBoot框架整合SwaggerUI的示例代码

<dependencies>

     <dependency>

         <groupId>org.springframework.boot</groupId>

         <artifactId>spring-boot-starter-web</artifactId>

         <scope>provided </scope>

     </dependency>

     <!--mybatis-plus-->

         <groupId>com.baomidou</groupId>

         <artifactId>mybatis-plus-boot-starter</artifactId>

     <!--lombok用来简化实体类：需要安装lombok插件-->

         <groupId>org.projectlombok</groupId>

         <artifactId>lombok</artifactId>

     <!--swagger-->

         <groupId>io.springfox</groupId>

         <artifactId>springfox-swagger2</artifactId>

         <artifactId>springfox-swagger-ui</artifactId>

     <!-- redis -->

         <artifactId>spring-boot-starter-data-redis</artifactId>

     <!-- spring2.X集成redis所需common-pool2

         <groupId>org.apache测试数据mons</groupId>

         <artifactId>commons-pool2</artifactId>

         <version> 2.6 . 0 </version>

     </dependency>-->

</dependencies>

package com.xsha.servicebase;

import com.google测试数据mon.base.Predicates;

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.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;

@Configuration

@EnableSwagger2

public class SwaggerConfig {

     @Bean

     public Docket webApiConfig(){

         return new Docket(DocumentationType.SWAGGER_2)

                 .groupName( "webApi" )

                 .apiInfo(webApiInfo())

                 .select()

                 .paths(Predicates.not(PathSelectors.regex( "/admin/.*" )))

                 .paths(Predicates.not(PathSelectors.regex( "/error.*" )))

                 .build();

     }

     private ApiInfo webApiInfo(){

         return new ApiInfoBuilder()

                 .title( "网站标题" )

                 .description( "接口文档的描述信息" )

                 .version( "1.0" )

                 .contact( new Contact( "java" , "http://HdhCmsTestbaidu测试数据" , "1234567890@qq测试数据" ))

}

<dependency>

     <groupId>com.xsha</groupId>

     <artifactId>service_base</artifactId>

     <version> 0.0 . 1 -SNAPSHOT</version>

</dependency>

public interface ResultCode {

     //定义两个状态码

     public static int SUCCESS = 20000 ;

     public static int ERROR = 40000 ;

}

package com.xsha测试数据monutils;

import io.swagger.annotations.ApiModelProperty;

import lombok.Data;

import java.util.HashMap;

import java.util.Map;

// 统一返回结果类

@Data

public class R {

     @ApiModelProperty (value = "是否成功" )

     private Boolean success;

     @ApiModelProperty (value = "返回码" )

     private Integer code;

     @ApiModelProperty (value = "返回消息" )

     private String message;

     @ApiModelProperty (value = "返回数据" )

     private Map<String, Object> data = new HashMap<String, Object>();

     // 把构造方法定为私有

     private R() {}

     // 成功静态方法

     public static R ok() {

         R r = new R();

         r.setSuccess( true );

         r.setCode(ResultCode.SUCCESS);

         r.setMessage( "成功" );

         return r;

     }

     // 失败静态方法

     public static R error() {

         r.setSuccess( false );

         r.setCode(ResultCode.ERROR);

         r.setMessage( "失败" );

     public R success(Boolean success){

         this .setSuccess(success);

         return this ;

     public R message(String message){

         this .setMessage(message);

     public R code(Integer code){

         this .setCode(code);

     public R data(String key, Object value){

         this .data.put(key, value);

     public R data(Map<String, Object> map){

         this .setData(map);

}

<dependency>

     <groupId>com.xsha</groupId>

     <artifactId>common_utils</artifactId>

     <version> 0.0 . 1 -SNAPSHOT</version>

</dependency>

// please use rest style

// 1.select all teachers data

@ApiOperation (value = "所有数据列表" )

@GetMapping ( "findAll" )

public R findAllTeachers() {

     List<EduTeacher> teachers = teacherService.list( null );

     return R.ok().data( "results" , teachers);

}

// request path mast have variable id

// 2.logically delete teacher

@ApiOperation (value = "逻辑删除数据" )

@DeleteMapping ( "{id}" )

public R logicDeleteTeacher( @ApiParam (name= "id" , value= "讲师ID" , required = true ) @PathVariable String id) {

     boolean flag = teacherService.removeById(id);

     return flag? R.ok(): R.error();

}