SpringBoot集成Swagger2构建在线API文档的代码详解

    
      io.springfox
      springfox-swagger-ui
      2.4.0
    
    
      io.springfox
      springfox-swagger2
      2.4.0
    
    
      com.github.xiaoymin
      swagger-bootstrap-ui
      1.6
    

package com.liud.demo.config;

import io.swagger.annotations.ApiOperation;
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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * TODO
 * swagger2配置类
 * @author liud
 * @version 1.0
 */

@Configuration
@EnableSwagger2
public class Swagger2 {
  //配置swagger2核心配置
  @Bean
  public Docket createRestApi(){
    return new Docket(DocumentationType.SWAGGER_2) //指定api类型位swagger2
        .apiInfo(apiInfo())            //用于定义api文档汇总信息
        .select()
        //.apis(RequestHandlerSelectors.basePackage("com.liud.demo.controller")) //指定生成文档的controller
        //.apis(RequestHandlerSelectors.any()) //为任何接口生成API文档
        //.apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) //为有@Api注解的Controller生成API文档
        .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) //为有@ApiOperation注解的方法生成API文档
        .paths(PathSelectors.any())
        .build();
  }

  //api基本信息
  private ApiInfo apiInfo(){
    return new ApiInfoBuilder()
        .title("SpringBootDemo的项目接口API") //文档标题
        .contact(new Contact("liud", //作者
            "",
            "")) //联系人
        .description("SpringBootDemo的项目接口API")//详细信息
        .version("1.0.0")//文档版本号
        .termsOfServiceUrl("")//网站地址
        .build();
  }
}

package com.liud.demo.controller;

import com.liud.demo.service.HelloService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.*;

import javax.servlet.http.HttpServletRequest;

/**
 * TODO
 *
 * @author liud
 * @version 1.0
 */
@RestController
@Api(tags = {"hello操作接口"})
public class HelloController {
  @ApiOperation(value = "根据用户名获取用户信息接口")
  @RequestMapping(value = "/getuserinfo",method = RequestMethod.POST)
  public String getUserInfo(HttpServletRequest request,
               @ApiParam(name="username",value = "用户名",required = true) String username){
    return "输入的姓名："+username+",这个用户的信息已经存在！";
  }
}

@ApiParam(name="username",value = "用户名",required = true) String username