飞道的博客

5. 尚融宝后端添加积分等级、逻辑删除、Swagger2

183人阅读  评论(0)

一、积分等级列表接口

1、编写积分等级管理接口

修改service-core模块

controller包下新建admin

新建AdminIntegralGradeController.java

package com.indi.srb.core.controller.admin;

@CrossOrigin
@RestController
@RequestMapping("/admin/core/integralGrade")
public class AdminIntegralGradeController{
   
	@Resource
	private IntegralGradeService integralGradeService;
	
	@GetMapping("/list")
	public List<IntegralGrade> listAll(){
   
		return integralGradeService.list();
	}
}

2、测试

重启服务,访问: http://localhost:8110/admin/core/integralGrade/list ,结果是json数据

二、逻辑删除接口

1、添加删除方法

修改AdminIntegralGradeController.java

	@DeleteMapping("/remove/{id}")
	public Boolean removeById(@PathVariable Long id){
   
		return integralGradeService.removeById(id);
	}

2、使用postman测试删除

三、配置Swagger2

1、Swagger2配置文件

service-base模块中com.indi.srb.base.config包下

创建Swagger2Config.java

package com.indi.srb.base.config;

@Configuration
public class Swagger2Config{
   
	return new Docket(DocumentationType.SWAGGER_2);
}

AdminIntegralGradeController.java添加

定义在类上

@Api(tags = "积分等级管理")

定义在方法上

	@ApiOperation("积分等级列表")
	
	@ApiOperation(value = "根据id删除数据记录",notes = "删除数据")

定义在参数上

            @ApiParam(value = "数据id", example = "100", required = true)

2、测试

访问http://localhost:8110/swagger-ui.html


3、接口分组配置

修改Swagger2Config.java

	@Bean
	public Docket adminApiConfig(){
   
		return new Docket(DocumentationType.SWAGGER_2)
				.groupName("adminApi")
				.select()
				.path(Predicates.and(PathSelectors.regex("/admin/.*")))
				.build();
	}
	
	@Bean
	public Docket webApiConfig(){
   
		return new Docket(DocumentationType.SWAGGER_2)
				.groupName("webApi")
				.select()
				.path(Predicates.and(PathSelectors.regex("/web/.*")))
				.build();
	}

修改service-coreIntegralGradeController.java

4、测试

通过添加过滤条件,有效的对接口进行了分组

5、文档描述配置

修改Swagger2Config.java

    private ApiInfo adminApiInfo(){
   
        return new ApiInfoBuilder()
                .title("尚融宝后台管理系统API文档")
                .description("本文档描述了尚融宝后台管理系统的各个模块的接口的调用方式")
                .version("1.6")
                .contact(new Contact("Alvin","https://blog.csdn.net/alvin199765/category_10977371.html","UnityAlvin@qq.com"))
                .build();
    }

	private ApiInfo webApiInfo(){
   
        return new ApiInfoBuilder().title("尚融宝网站API文档")
                .description("本文档描述了尚融宝网站的各个模块的接口的调用方式")
                .version("1.6")
                .contact(new Contact("Alvin","https://blog.csdn.net/alvin199765/category_10977371.html","UnityAlvin@qq.com"))
                .build();
    }

6、测试



转载:https://blog.csdn.net/Alvin199765/article/details/115854670
查看评论
* 以上用户言论只代表其个人观点,不代表本网站的观点或立场