- 导入依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
- swagger配置类 SwaggerConfig
package com.yunnuo.demo.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;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createDocket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.yunnuo.demo.controller"))
.paths(PathSelectors.any())
.build();
}
public ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("MyBatis + SqLite 简单项目程序")
.termsOfServiceUrl("小诺大人")
.version("1.0")
.build();
}
}
- controller设置swagger注解
package com.yunnuo.demo.controller;
import com.yunnuo.demo.entity.User;
import com.yunnuo.demo.service.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RestController
@RequestMapping(value = "/user")
@Api(value = "用户类" ,tags = "用户操作接口")
public class UserInfoController {
@Autowired
private UserService userService;
@GetMapping(value = "/findUserInfoList")
@ApiOperation(value="获取用户列表", notes="获取用户列表")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", value = "用户ID", required = false, paramType = "query")
})
public List<User> findUserInfoList(String id){
return userService.findUserList(id);
}
@GetMapping(value = "/findUserById")
@ApiOperation(value="根据Id获取用户", notes="根据Id获取用户")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", value = "用户ID", required = true, paramType = "query")
})
public User findUserById(int id){
return userService.selectById(id);
}
}
访问:http://localhost:8080/swagger-ui.html