Spring Boot如何集成Swagger

发布时间:2024-11-15 10:56:01 作者:小樊
来源:亿速云 阅读:82

要在Spring Boot项目中集成Swagger,请按照以下步骤操作:

  1. 添加依赖

在你的pom.xml文件中添加Swagger和Swagger UI的依赖:

<dependencies>
    <!-- Spring Boot Starter Web, includes Spring MVC -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Swagger Core Library -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>

    <!-- Swagger UI Library -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>

    <!-- Spring Boot Starter Test, includes testing utilities -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>
  1. 配置Swagger

创建一个新的Java类,例如SwaggerConfig.java,并添加以下代码:

import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo")) // 替换为你的包名
                .paths(PathSelectors.any())
                .build();
    }
}

这段代码会启用Swagger2,并告诉Swagger扫描指定包下的所有控制器(Controller)。

  1. 创建API接口

在你的项目中创建一个简单的REST API接口。例如,创建一个名为UserController.java的文件,并添加以下代码:

package com.example.demo;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {
    @GetMapping("/users")
    public String getUser(@RequestParam(value = "name", defaultValue = "World") String name) {
        return String.format("Hello %s!", name);
    }
}
  1. 访问Swagger UI

启动你的Spring Boot应用程序,然后在浏览器中访问http://localhost:8080/swagger-ui.html。你应该能看到Swagger UI界面,其中列出了你的项目中所有可用的API接口。点击任意接口,你可以查看其文档和示例请求。

现在你已经成功在Spring Boot项目中集成了Swagger。

推荐阅读:
  1. spring-boot-plus是易于使用,快速,高效,功能丰富,开源的spring boot 脚手
  2. SpringBoot 集成 Swagger的案例

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

spring boot

上一篇:Spring Boot环境变量使用技巧

下一篇:Spring Boot日志框架选择策略

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》