springboot配置swagger-rest文档

提示：扫一扫查出行
【扫一扫了解最新限行尾号】
复制提示

前言

swagger是一个很好的restful形式的api文档，可以通过比较小的侵入来提供很好的restful的文档。因为swagger是依赖服务生成的，所以其实是依赖服务的，这也算是它的一个小缺点吧。但是其实如果一个项目习惯去手写文档之后，也是可以的，但是新的项目还是建议去用一些自动生成的文档，省去了很多麻烦。

spring boot配置swagger

引入swagger依赖

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

编写swagger对应的配置

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 {

@Bean public Docket createRestApi() { // 文档类型 return new Docket(DocumentationType.SWAGGER_2) // 创建api的基本信息 .apiInfo(apiInfo()) // 选择哪些接口去暴露 .select() // 扫描的包 .apis(RequestHandlerSelectors.basePackage("com.demo.web.controller")) .paths(PathSelectors.any()) .build(); }private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("groundhog-web swagger文档") .contact("name") .version("1.0") .build(); }

}

在api和请求参数中使用注解

接口中使用swagger注解

@RestController @Api(value = "测试swagger", description = "测试swagger api") public class TestSwaggerController {

@ApiOperation(value = "返回url中的参数", notes = "返回url中的参数") @ApiImplicitParam(name = "id", value = "id值", paramType = "path", required = true, dataType = "Integer") @GetMapping(path = "/getUrlParam/{id}") public Integer getUrlParam(@PathVariable(value = "id") Integer id) { return id; }

}

可以访问localhost:port/swagger-ui.html看到生成的swagger文档。可以看到请求结果：