Swagger2+knife4j

最新推荐文章于 2024-10-12 10:40:20 发布

原创最新推荐文章于 2024-10-12 10:40:20 发布 · 837 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#swagger2

Swagger2+knife4j 同时被 2 个专栏收录

1 篇文章

订阅专栏

Swagger2ui

1 篇文章

订阅专栏

本文介绍了如何使用Swagger2和knife4j搭建API文档系统。主要内容包括：Swagger2及knife4j所需依赖的引入，Swagger2配置类的编写，通过实体类与控制层展示API文档。文中还详细解释了关键注解的使用方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Swagger2+knife4j

导入Swagger的所要用的jar包

  <!-- Swagger2 核心依赖 -->
 		<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
  <!-- Swagger2 ui页面 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>
   <!--配合Swagger2 形成一个knife4j页面 -->      
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.4</version>
        </dependency>

创建一个Swagger2的配置类

package com.liu.testing.testing.util;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration//托管spring
@EnableSwagger2//开启swagger功能
public class Swagger {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.liu.testing.testing.controller"))//包名
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("破破烂烂的项目")
                .description("这里些什么~~")//简介
                .termsOfServiceUrl("com.liu.testing.testing")
                .contact("程序猿")//作者
                .version("version 1.0")//版本
                .build();
    }

}

然后生成一个页面就是这样子的: 在这里插入图片描述
这些都不重要。。。

重要是要怎么把写api展示出来

接下来去启动类里面添加，来告诉项目运用上了这个插件

@EnableSwagger2

先展示一个实体类

@Data
@EqualsAndHashCode(callSuper = false)
@ApiModel(“用户表”)
public class Users implements Serializable {
.
private static final long serialVersionUID = 1L;
.
@ApiModelProperty(value = “用户id”)
private int id;
.
@ApiModelProperty(value = “用户”)
private String user;
.
@ApiModelProperty(value = “密码”)
private String pwd;
.
@ApiModelProperty(value = “技能表id”)
private Integer occupationId;

}

ok 实体类完成了其实@ApiModelProperty这个注解有好多参数我这么写是够用了

@ApiModelProperty(value = “用户id”,name=“id”,dataType=true,example=“列子”)

接下来展示控制层

在这里插入图片描述

可以请求过去查看数据库里的的数据

@RestController
@RequestMapping("/users")
@Api(tags="用户模块")//页面上的左侧导航
public class UsersController {

    @Autowired
    private IUsersService  iUsersService;

     @ApiOperation(value="用户模糊查询",notes="根据姓名或手机号查询用户")
     @ApiImplicitParams({
            @ApiImplicitParam(name="name",value="姓名",required = false,dataType ="String",paramType = "path"),
            @ApiImplicitParam(name="phone",value="手机号",required = false,dataType ="String",paramType = "query")
    })
    @GetMapping("selectUser")
    public  Users selectUser(){
         return iUsersService.selectUser();
    }
  }