1.导入依赖(maven)
<!-- 引入swagger 相关的依赖 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version></dependency>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
3.在config 包下 创建SwaggerConfig类
@EnableSwagger2//重要!
@EnableWebMvc
@ComponentScan(basePackages = "com.tina.controller")//扫描control所在的package请修改为你control所在package
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("测试接口文档")
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.tina.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("springboot利用swagger构建api文档")
.description("简单优雅的restful风格,http://blog.csdn.net/saytime")
.termsOfServiceUrl("http://blog.csdn.net/saytime")
.version("1.0")
.build();
}
}
4.在spring mvc.xml中添加一个配置
<!-- 加载SwaggerConfig 类名改成自己创建的-->
<bean class="com.tina.config.SwaggerConfig"/>
5.在自己的controller包下创建DemoController.java
@RestController
@ResponseBody
@Api(value = "test模块")
@RequestMapping("/test")
public class DemoController {
@GetMapping("/demo")
@ApiOperation(value = "测试get的方法")
public Object demo(){
return "测试get成功~~";
}
}
6.点击运行
http://localhost:8080/swagger-ui.html#