Swagger快速入门

古城微笑少年丶 2024-03-26 20:27 61阅读 0赞

在pom文件中引入依赖

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

在WebMvcConfig配置类加入@EnableSwagger2 、@EnableKnife4j 注解

@Configuration
    @EnableSwagger2  //开启swagger接口权限
    @EnableKnife4j   //开启knife4j接口权限
    public class WebMvcConfig extends WebMvcConfigurationSupport {
    
    }

在WebMvcConfig配置类中开启静态资源访问

@Override
        protected void addResourceHandlers(ResourceHandlerRegistry registry) {
            log.info("静态资源请求成功~~");
            registry.addResourceHandler("/backend/**").addResourceLocations("classpath:/backend/");
            registry.addResourceHandler("/front/**").addResourceLocations("classpath:/front/");
    
            //Swagger静态资源
            registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
            registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
        }

在WebMvcConfig配置类中重写Swagger接口相关设置

@Bean
        public Docket createRestApi() {
            // 文档类型
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.aliyev.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("瑞吉外卖")
                    .version("1.0")
                    .description("瑞吉外卖接口文档")
                    .build();
        }

![e3b257f0cb759ea45652f9e6250df131.png][]

如果有写过滤器还需为其静态资源放行，相关静态资源如下：

"/doc.html",
    "web.jar/**",
    "/swagger-resources",
    "/v2/api-docs"

完成以上就可以生成接口文档啦，当然只完成一半！！！

启动项目，访问doc.html页面即可看到对应的接口

![78b42dfb8d34031494b40afa2b1373cf.png][]

但此时发现这些接口为啥都是英文的啊，这里就不得不使用Swagger常用注解！！！

![c7fdc8a2a6901b0999940311612a7aba.png][]

涉及相关用法如下：

//实体类
    @ApiModel("用户信息")
    public class User{
        @ApiModelProperty("主键")
        private Long id;
    }

//Controller控制类
    @RestController
    @RequestMapping("/user")
    @Api(tags = "用户相关接口")
    public class UserController{
        @PostMapping
        @ApiOperation(value = "新增用户")
        @ApilimplicitParams({
            @ApilimplicitParam(name = "name",value = "姓名", required = false) //指明name这个参数非必须传入
             @ApilimplicitParam(name = "age",value = "年龄", required = true) //指明age这个参数必须传入
        })
        public Result<String> save(String name,int age){
        }
    }

这样生成的接口文档就不是英文的啦，显示的相关信息就是我们设置的。

[e3b257f0cb759ea45652f9e6250df131.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/d7896872d8ee4ddb85bda271de33eaa9.png
[78b42dfb8d34031494b40afa2b1373cf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/276a30a738284f08af2e501733e9b6e8.png
[c7fdc8a2a6901b0999940311612a7aba.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/e5756a7ba89845c1a2495f522dc73a73.png