Swagger2 API 控制台

用于简化前后端人员的交互，便于前端人员测试和使用API

1.引入jar

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

2.创建配置类

import java.util.ArrayList;
import java.util.List;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {

	/**
	 * @Description:swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
	 */
	@Bean
	public Docket createRestApi() {
		
		// 为swagger添加header参数可供输入  
        ParameterBuilder userTokenHeader = new ParameterBuilder();
        ParameterBuilder userIdHeader = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();  
        userTokenHeader.name("headerUserToken").description("userToken")
        	.modelRef(new ModelRef("string")).parameterType("header")
        	.required(false).build();  
        userIdHeader.name("headerUserId").description("userId")
	    	.modelRef(new ModelRef("string")).parameterType("header")
	    	.required(false).build(); 
        pars.add(userTokenHeader.build());
        pars.add(userIdHeader.build());
		
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
				.apis(RequestHandlerSelectors.basePackage("com.sub.controller"))
				.paths(PathSelectors.any()).build()
				.globalOperationParameters(pars);
	}

	/**
	 * @Description: 构建 api文档的信息
	 */
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				// 设置页面标题
				.title("使用swagger2构建后端api接口文档")
				// 设置联系人
				.contact(new Contact("wxh", "http://www.1234.com", "wxh@163.com"))
				// 描述
				.description("欢迎访问接口文档，这里是描述信息")
				// 定义版本号
				.version("1.0").build();
	}
}

3.例子（API开头的注解）

@ApiOperation(value = "用户注册", notes = "用户注册的接口")
	@PostMapping("/regist")
	@ApiImplicitParam(name="userId", value="用户id", required=true,
			dataType="String", paramType="query")
	public JSONResult regist(@RequestBody Users user,String userId) throws Exception {

		//1.判断用户名和密码必须不为
		String username = user.getUsername();
		String password = user.getPassword();
		if(StringUtils.isBlank(username)||StringUtils.isBlank(password)){
			return JSONResult.errorMsg("用户名和密码不能为空");
		}
		//2.判断用户名是否存在
        Boolean usernameIsExist = userServices.queryUsernameIsExit(username);

		//3.保存用户，注册信息
		if (!usernameIsExist) {
			user.setNickname(username);
			user.setPassword(MD5Utils.getMD5Str(password));
			user.setFansCounts(0);
			user.setReceiveLikeCounts(0);
			user.setFollowCounts(0);
			userServices.saveUser(user);
		}else {
			return JSONResult.errorMsg("用户名已存在");
		}
		return JSONResult.ok();
	}

@ApiModel(value = "用户对象",description = "这是用户对象")
public class Users {
    @ApiModelProperty(hidden = true)
    @Id
    private String id;

    /**
     * 用户名
     */
    @ApiModelProperty(value = "用户名",name = "username",example = "xiaoming",required = true)
    private String username;

    /**
     * 密码
     */
    @ApiModelProperty(value = "密码",name = "password",example = "123456",required = true)
    private String password;

3.网址 http://127.0.0.1:8085/swagger-ui.html 效果