day01-项目概述、环境搭建
目录
1 软件开发整体介绍
软件开发流程
角色分工
软件环境
2 苍穹外卖项目介绍
项目介绍
产品原型
技术选型
3 开发环境搭建
前端环境搭建
编辑
后端环境搭建
nginx 反向代理
完善登录功能
4 导入接口文档
前后端分离开发流程
操作步骤
5 Swagger
介绍
使用方式
常用注解
1 软件开发整体介绍
软件开发流程
角色分工
软件环境
2 苍穹外卖项目介绍
项目介绍
产品原型
技术选型
3 开发环境搭建
前端环境搭建
注意:
- Nginx目录必须放在没有中文的目录中才能正常运行
- 当前Nginx的配置文件中已经配置了反向代理,通过此配置可以将前端请求转发到后端服务
后端环境搭建
nginx 反向代理
完善登录功能
问题:
员工表中的密码是明文存储,安全性太低。
解决
将密码加密后存储,提高安全性
使用MD5加密方式对明文密码加密
步骤
password = DigestUtils.md5DigestAsHex(password.getBytes());
4 导入接口文档
前后端分离开发流程
操作步骤
将课程资料中提供的项目接口导入YApi。
5 Swagger
介绍
使用Swagger你只需要按照它的规范去定义接口及接口相关的信息,就可以做到生成接口文档,以及在线接口调试页面。
官网:
https://swagger.io/
Knife4j 是为Java MVC框架集成Swagger生成Api文档的增强解决方案。
使用方式
导入 knife4j 的maven坐标
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
在配置类中加入 knife4j 相关配置
/**
* 通过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/");
}
接口文档访问路径为
http://localhost:8080/doc.html
接口测试
通过 Swagger 就可以生成接口文档,那么我们就不需要 Yapi 了?
1、Yapi 是设计阶段使用的工具,管理和维护接口
2、Swagger 在开发阶段使用的框架,帮助后端开发人员做后端的接口测试
2个都要用
常用注解
通过注解可以控制生成的接口文档,使接口文档拥有更好的可读性,常用注解如下:
@Api
@ApiOperation
@ApiModel @ApiModelProperty
注解可以影响生成的接口文档