前后端分离开发:
YApi:
Swagger:
介绍:
使用:
依赖:
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
配置注解:
// WebMvcConfig.java
@Slf4j
@Configuration
@EnableSwagger2
@EnableKnife4j
public class WebMvcConfig extends WebMvcConfigurationSupport {
...
@Bean
public Docket createRestApi() {
// 文档类型
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("controller全包名")) // 去扫描该包下的mapping接口映射
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("瑞吉外卖")
.version("1.0")
.description("瑞吉外卖接口文档")
.build();
}
}
设置静态资源映射:
// WebMvcConfig.java
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
log.info("static resources mapping...");
registry.addResourceHandler("/backend/**").addResourceLocations("classpath:/backend/");
registry.addResourceHandler("/front/**").addResourceLocations("classpath:/front/");
registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
用于访问doc.html(程序生成的接口文档)
登录过滤:
// LoginCheckFilter.doFilter()
// 不需要检测登录状态的url
String[] urls = {
"/employee/login",
"/employee/logout",
"/backend/**",
"/front/**",
"/user/sendMail",
"/user/login",
"/doc.html",
"/webjars/**",
"/swagger-resources",
"/v2/api-docs"
};
便于访问,否则需要登录才能访问
直接访问http://localhost:8080/doc.html
可见接口文档页面:
导出:文档管理->离线文档
openAPI可用于导入YApi进行管理
常用注解:
部署:
用户请求->Nginx服务器:静态页面展示
Nginx服务器->Tomcat服务器:前端调用API,Nginx负责请求分发(负载均衡),实际是多个Tomcat(集群)对应一台Nginx
Tomcat服务器->Redis服务器:命中缓存
Tomcat服务器->MySQL服务器:CRUD数据库