sprinboot系列六——整合swagger

配置

pom:

<!-- swagger RESTful API 文档 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.2.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.2.2</version>
</dependency>

Swagger2Config:

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

/**
 * @author zzzH
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {

        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("一百万项目接口文档")
                .description("一百万项目接口文档，符合RESTful API。")
                .version("2.0")
                .build();

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("boot.controller")) //以扫描包的方式
                .paths(PathSelectors.any())
                .build();
    }

}

整合

实体,

设置实体类名称，属性，以及默认值：

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@Data
@ApiModel(description = "展示按钮实体类")
public class AppearIcon {
    private Long id;

    @ApiModelProperty("当前网点")
    private String srcDeptcode;
}

方法

@Api(value = "测试模块")
@RestController
public class TestController {
	
	@Autowired
	RedisSetting redisSetting;
	@Autowired
	RedisService redisService;
	@Autowired
	AppearIconMapper appearIconMapper;
	
	private final Logger logger = LoggerFactory.getLogger(TestController.class);
	
	@ApiOperation(value = "获取用户列表", notes = "获取用户列表")
	@RequestMapping(value = "/hi2", method = RequestMethod.POST)
	@ResponseBody
	public String hi(@RequestBody  @ApiParam(value = "用户数据") AppearIcon appear) {
		return "hi, I'm springboot !"+Hello.hello;
	}
	}

@RequestBody

@RequestBody是作用在形参列表上，用于将前台发送过来固定格式的数据【xml 格式或者 json等】封装为对应的 JavaBean 对象，封装时使用到的一个对象是系统默认配置的 HttpMessageConverter进行解析，然后封装到形参上。

@ResponseBody

@ResponseBody是作用在方法上的，@ResponseBody 表示该方法的返回结果直接写入 HTTP response body 中，一般在异步获取数据时使用【也就是AJAX】，在使用 @RequestMapping后，返回值通常解析为跳转路径，但是加上 @ResponseBody 后返回结果不会被解析为跳转路径，而是直接写入 HTTP response body 中。 比如异步获取 json 数据，加上 @ResponseBody 后，会直接返回 json 数据。@RequestBody 将 HTTP 请求正文插入方法中，使用适合的 HttpMessageConverter 将请求体写入某个对象。

使用

输入项目地址+swagger-ui.html#即可完成使用

Api2Doc在项目中也有使用，大家可以根据自己的项目选择