学习目标：项目概述、环境搭建

项目概述

该项目是为一个餐馆打造的外卖点单程序。有用户使用的手机端以及后台管理使用的电脑端。该项目，学习者开发的主要是后端处理的业务逻辑：客户的点单以及商家对该订单的处理——接受订单，派送订单，订单送达。这一过程要在后台管理界面和用户手机端同步。同时后端还需要处理员工登录和管理，统计数据等功能。综合性比较强。该项目是结合实际场景开发，实现业务逻辑的应用，涉及dto，vo等进阶知识，不是tlias中只有pojo的概念了。

环境搭建

Java后端环境：我使用的是jdk17，mysql9.5.0，springboot 2.7.3，开发平台为IntelliJ IDEA ,数据库连接工具为datagrip。

完成了github仓库的创建，并使用apifox取代原教程中的Yapi，和swagger/knife4j一起对接口进行维护和调试。

关键知识

接口文档的自动生成配置：

@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {

    @Autowired
    private JwtTokenAdminInterceptor jwtTokenAdminInterceptor;

    /**
     * 注册自定义拦截器
     *
     * @param registry
     */
    protected void addInterceptors(InterceptorRegistry registry) {
        log.info("开始注册自定义拦截器...");
        registry.addInterceptor(jwtTokenAdminInterceptor)
                .addPathPatterns("/admin/**")
                .excludePathPatterns("/admin/employee/login");
    }

    /**
     * 通过knife4j生成接口文档
     * @return
     */
    @Bean
    public Docket docket() {
        log.info("开始生成接口文档");
        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) {
        log.info("开始进行静态资源映射...");
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

相关注解的使用：

// 以这个VO为例展示，通过注解控制生成的接口文档相关值属性
@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;

}

通过相关配置可以修改生成的接口文档内容，更好进行测试。如图，接口调试面板和返回值都加上了相关说明。