省去了,开发人员整理繁琐的API接口文档,此框架为我们自动化了这些事情,但是需要程序员在代码中集成这个框架。
swagger2常用注解说明
官方网站
Swagger2配合springboot使用
pom.xml引入maven配置
<!-- swagger2 begin -->
<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>
<!-- swagger2 end -->
在springboot启动类,同级目录下,创建类Swagger2
/**
* @author gao peng
* @date 2018/8/14 17:42
*/
@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.gp.demogp.web"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("demogp中使用Swagger2构建RESTful APIs")
.description("demogp中使用Swagger2构建RESTful APIs")
// .termsOfServiceUrl("http://blog.didispace.com/")
// .contact("程序猿DD")
.version("1.0")
.build();
}
}
可以使用了,可以在接口上使用Swagger为我们提供的注解。
/**
* @author gao peng
* @date 2018/8/14 17:36
*/
@RestController
@RequestMapping(path = "/restfulAPIController")
@Api(value="用户controller",tags={"用户操作接口"})
public class RestfulAPIController {
@ApiOperation(value = "测试接口", notes = "测试接口DEMO")
@RequestMapping(value = "/demo", method = RequestMethod.GET)
public Map getInfo() {
Map map = new HashMap();
map.put("name", "zhangsan");
map.put("sex", "boy");
return map;
}
}
效果图如下: