java配置开发文档

weixin_65019617

已于 2023-08-31 17:52:55 修改

阅读量42

点赞数

文章标签： java

于 2023-08-31 17:37:11 首次发布

本文链接：https://blog.csdn.net/weixin_65019617/article/details/132608169

版权

导入依赖

		<!--生成swagger接口文档-->
		<dependency>
			<groupId>com.github.xiaoymin</groupId>
			<artifactId>knife4j-spring-boot-starter</artifactId>
			<version>3.0.2</version>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>

WebMvc配置

package com.example.config;

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
@Slf4j
public class WebMvcConfig extends WebMvcConfigurationSupport {
    /**
     * 通过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)
                .groupName("用户端接口")
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))//控制层路径
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
    /**
     * 设置静态资源映射
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        log.info("开始设置静态资源映射...");
        log.info("开始设置静态资源映射...");
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");//配置文档的路径
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

常见注解

@Api(tags = "查询用户id接口")//用于在控制器类上标注，指示该控制器的相关信息
@ApiOperation("测试")//用于在控制器方法上标注，指示该方法的作用、描述等
@ApiModel("用户登录DTO")//在DTO类上标注，用于描述一个实体类
@ApiModelProperty("登录用户名")//用于描述实体类的属性(自己定义的接收变量)，即类的字段