3.25

精进后端项目结构

首先是POJO类//java对象,只有属性与getset方法

entity类//用于与数据库的数据对应

DTO类//用于数据传输对象,通常用于程序间各层之间传递数据

VO类//视图对象,为前端提供展示数据的对象

 

.gitignore:当你把项目提交到git的时候,这里面可以写一些不必要上传的文件,例如:

**/target/
.idea
*.iml
*.class
*Test.java
**/test/

 

yapi网站可以在开发初期管理维护接口:用于设计阶段,而接下来的swagger则是主要用于后端接口测试

使用knife4j

 1.导入knife4j

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-spring-boot-starter</artifactId>
</dependency>

2.配置Bean

复制代码
  /**
     * 通过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/");
    }
复制代码

3.swagger常用注解

 

posted @ 2024-03-25 21:57  灬倾夏  阅读(8)  评论(0)    收藏  举报