springboot 2.7 springboot 2.6 整合 swagger3

添加依赖

        <!--swagger相关依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>

增加配置

@Configuration
@EnableOpenApi
@Data
@ConfigurationProperties(prefix = "swagger")
public class SwaggerConfig {


    /**
     * 是否开启swagger,生产环境一般关闭,所以这里定义一个变量
     */
    private Boolean enable;

    /**
     * 项目应用名
     */
    private String applicationName;

    /**
     * 项目版本信息
     */
    private String applicationVersion;

    /**
     * 项目描述信息
     */
    private String applicationDescription;

    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.OAS_30)
                .pathMapping("/")

                // 定义是否开启swagger,false为关闭,可以通过变量控制,线上关闭
                .enable(enable)

                //配置api文档元信息
                .apiInfo(apiInfo())

                // 选择哪些接口作为swagger的doc发布
                .select()

                //apis() 控制哪些接口暴露给swagger,
                // RequestHandlerSelectors.any() 所有都暴露
                // RequestHandlerSelectors.basePackage("com.demo.security.*")  指定包位置
                // withMethodAnnotation(ApiOperation.class)标记有这个注解 ApiOperation
                .apis(RequestHandlerSelectors.basePackage("com.demo.security.controller"))

                .paths(PathSelectors.any())

                .build();
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(applicationName)
                .description(applicationDescription)
                .version(applicationVersion)
                .build();
    }
}
server:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher
swagger:
  enable: true
  application-name: security-demo
  application-version: 1.0.0
  application-description: client

验证

地址:http://localhost:8080/doc.html
在这里插入图片描述

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
### 回答1: Spring Boot 2.6整合Swagger可以通过以下步骤实现: 1. 在pom.xml文件中添加Swagger依赖: ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3..</version> </dependency> ``` 2. 在启动类上添加@EnableSwagger2注解: ```java @SpringBootApplication @EnableSwagger2 public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` 3. 配置Swagger: ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("API文档") .description("API文档") .version("1.") .build(); } } ``` 4. 在Controller类上添加Swagger注解: ```java @RestController @Api(tags = "用户管理") @RequestMapping("/user") public class UserController { @ApiOperation(value = "获取用户列表", notes = "获取用户列表") @GetMapping("/list") public List<User> list() { return userService.list(); } @ApiOperation(value = "添加用户", notes = "添加用户") @PostMapping("/add") public void add(@RequestBody User user) { userService.add(user); } } ``` 以上就是Spring Boot 2.6整合Swagger的基本步骤,可以根据实际需求进行配置和调整。 ### 回答2: Spring Boot是一个快速开发的开源框架,其对Spring框架进行了封装,简化了Spring应用的配置和部署。Swagger是一个RESTful风格的API框架,可以帮助我们根据API生成文档、测试API、交互式地调用API等。 在Spring Boot 2.6中,整合Swagger变得更加简单,只需要引入相应的依赖即可开始使用。具体的步骤如下: 1. 引入Swagger依赖 在pom.xml文件中添加以下依赖: ``` <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>3.0.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 2. 配置Swagger 在程序的启动文件中添加Swagger配置类,如下: ``` @Configuration @EnableSwagger2WebMvc public class SwaggerConfiguration { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo")) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("REST API Documentation") .description("Example API Documentation") .version("1.0.0") .build(); } } ``` 在上面的代码中,我们配置了Swagger Documentation的基本信息,并指定了要扫描的包。 3. 启动应用程序 配置完成后,我们可以启动应用程序了。当应用程序成功启动后,我们可以通过访问http://<host>:<port>/swagger-ui/来查看Swagger UI并测试API。 在Swagger UI界面中,我们可以找到每个API端点,并查看其文档和参数。我们可以测试每个API端点并查看其响应。 在整合Swagger过程中,需要注意的是,我们需要保证Swagger和Spring Boot的版本兼容,否则会引起一些异常或错误。同时,在编写API时,我们需要注意编写好文档和注释,以便Swagger可以正确生成API文档。 综上所述,Spring Boot 2.6整合Swagger非常简单,只需几个简单的步骤即可完成。Swagger使得API文档化和API测试变得更加简单,减少了我们的工作量和出错率。 ### 回答3: Spring Boot是一个非常流行的Java Web开发框架,而Swagger是一个API文档工具。通过使用Swagger,我们可以非常方便地为我们的API生成文档。在本篇文章中,我们将详细介绍如何在Spring Boot 2.6整合Swagger。 一、添加依赖 Swagger是一个开源的项目,我们可以通过Maven或Gradle进行依赖的配置。在这里,我们以Maven为例,添加以下依赖: ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>3.0.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 二、添加Swagger配置 在Spring Boot 2.6中,我们可以使用@EnableSwagger2WebMvc注解来启用Swagger。在配置类上添加该注解即可: ```java @Configuration @EnableSwagger2WebMvc public class SwaggerConfig { } ``` 我们也可以通过SwaggerDocket配置对象来定制Swagger的一些属性,例如API基本信息、扫描包路径等: ```java @Configuration @EnableSwagger2WebMvc public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.controller")) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Spring Boot Application") .description("This is a sample Spring Boot application using Swagger.") .version("1.0.0") .build(); } } ``` 在这个例子中,我们定义了API的基本信息:标题、描述和版本号。我们还使用了RequestHandlerSelectors.basePackage方法来扫描指定包路径下的Controller类。路径PathSelectors.any表示扫描所有路径。 三、访问Swagger UI 配置完成后,我们就可以通过Swagger UI来查看API文档了。在浏览器中输入http://localhost:8080/swagger-ui.html,就可以进入Swagger UI页面了。 在Swagger UI页面中,我们可以看到应用程序的所有API列表。我们可以单击每个API来查看它的详细信息,例如输入参数、输出参数等等。在右上角的控制台中,我们可以尝试发送HTTP请求,并查看响应结果。 总结 本文介绍了如何在Spring Boot 2.6整合Swagger。我们添加了Swagger依赖,配置了SwaggerDocket对象,并在浏览器中查看了API文档。Swagger使得我们可以很容易地为我们的API生成文档,从而快速了解和测试API。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

兴趣互联

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值