白马外卖:员工密码加密+swagger生成接口文档
使用Swagger你只需要按照它的规范去定义接口及接口相关的信息,就可以做到生成接口文档,以及在线接口调试页面。Knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案。Swagger 在开发阶段使用的框架,帮助后端开发人员做后端的接口测试。
·
1.完善登录功能
1.1问题:员工表中的密码是明文存储,安全性太低。

1.2步骤
1.修改数据库中明文密码,改为MD5加密后的密文
2.修改Java代码,前端提交的密码进行MD5加密后再跟数据库中密码比对

//密码比对
// 前端传递的明文密码进行md5加密处理
password = DigestUtils.md5DigestAsHex(password.getBytes());
2.swagger:

2.1介绍
使用Swagger你只需要按照它的规范去定义接口及接口相关的信息,就可以做到生成接口文档,以及在线接口调试页面。
官网:https://swagger.io/
Knife4j 是为Java MVC框架集成Swagger生成Api文档的增强解决方案。
Swagger 在开发阶段使用的框架,帮助后端开发人员做后端的接口测试
2.2使用方式
1.导入 knife4j 的maven坐标
2.在配置类中加入 knife4j 相关配置
3.设置静态资源映射,否则接口文档页面无法访问
- 传入依赖:
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
</dependency>
- 在配置类中,注册web层相关组件
/**
* 通过knife4j生成接口文档
* @return
*/
@Bean
public Docket docket() {
ApiInfo apiInfo = new ApiInfoBuilder()
.title("苍穹外卖项目接口文档")
.version("2.0")
.description("苍穹外卖项目接口文档")
.build();
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo)
.select()
.apis(RequestHandlerSelectors.basePackage("com.sky.controller"))
.paths(PathSelectors.any())
.build();
return docket;
}
/**
* 设置静态资源映射
* @param registry
*/
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
2.3常用注解:
通过注解可以控制生成的接口文档,使接口文档拥有更好的可读性,常用注解如下
@Api(tags = "员工相关接口")
public class EmployeeController {
@ApiOperation("员工登录")
public Result<EmployeeLoginVO> login(@RequestBody EmployeeLoginDTO employeeLoginDTO) {
@ApiOperation("员工退出")
public Result<String> logout() {
return Result.success();
}
@Data
@ApiModel(description = "员工登录时传递的数据模型")
public class EmployeeLoginDTO implements Serializable {
@ApiModelProperty("用户名")
private String username;
@ApiModelProperty("密码")
private String password;
}
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(description = "员工登录返回的数据格式")
public class EmployeeLoginVO implements Serializable {
@ApiModelProperty("主键值")
private Long id;
@ApiModelProperty("用户名")
private String userName;
@ApiModelProperty("姓名")
private String name;
@ApiModelProperty("jwt令牌")
private String token;
}
火山引擎开发者社区是火山引擎打造的AI技术生态平台,聚焦Agent与大模型开发,提供豆包系列模型(图像/视频/视觉)、智能分析与会话工具,并配套评测集、动手实验室及行业案例库。社区通过技术沙龙、挑战赛等活动促进开发者成长,新用户可领50万Tokens权益,助力构建智能应用。
更多推荐
所有评论(0)