1、现在大部分项目都是SpringBoot项目,所以首先引入依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
</dependency>
注:如果不是SpringBoot项目,请自行导入依赖包到lib
2、springboot启动类加上注解:@EnableSwagger2,并添加:
@Bean
public Docket swagerPlugin() {
return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
}
3、写示例接口:
@RestController
@RequestMapping("/law/datacenter")
@Api(value = "公示", tags = {"公示平台-公示结果接口"})
public class AgoPublicityController {
@Resource
IAgoPublicityService agoPublicityService;
@ApiOperation(value = "公示结果列表", notes = "公示结果列表。")
@GetMapping("result/list")
public ResultBean<PageDataModel<AgoPublicityModel>> getResultList(
@ApiParam(value = "传入需要查询的字段")
AgoPublicityModel agoPublicityModel, PageModel pageModel) {
return ResultBean.okPage(agoPublicityService.getResultList(agoPublicityModel,pageModel), pageModel);
4、访问:http://{host}:{port}/doc.html