在pom文件添加依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
</dependencies>
配置swaggerconfig类
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket docker() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
Contact contact = new Contact("付新宇","846510744@qq.com","846510744@qq.com");
return new ApiInfo(
"springbootdome测试接口",
"第一个springboot程序",
"1.0",
"www.baidu.com",
contact,
"fxy",
"http://www.apache.org/licenses/LICENSE-2.0",
new ArrayList()
);
}
}
注解说明
@Api("查询全部")
@RequestMapping("/list")
@RestController
public class controller {
@Autowired
private NoticeService noticeService;
@GetMapping("/list")
@ApiOperation(value="查询用户")
public List<Notice> list(@RequestParam(defaultValue = "1",value = "pageNum") Integer pageNum){
PageHelper.startPage(pageNum,3);
List<Notice> listNotice =noticeService.list();
return listNotice;
}
}
- @Api( “查询全部”) 当前controller的功能
- @ApiOperation(value=“查询”) 当前方法的作用
- @ApiModelProperty(value = “用户id”) 当参数是一个实体类时,写在实体类的字段上,表示该字段的意思