【web】Springboot3 集成 Swagger3

2024-01-09 18:26:33

Maven 依赖

<!--swagger3-->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.0.2</version>
</dependency>

配置类(可选)

  • 创建位置是任意的,我创建在 src/main/java/com/example/demo/config/SwaggerConfig.java
@Configuration
public class SwaggerConfig {

    @Bean
    public OpenAPI springOpenAPI() {
        return new OpenAPI().info(new Info()
                .title("SpringDoc API Test")
                .description("SpringDoc Simple Application Test")
                .version("1.0.0"));
    }
}

访问

示例

  • 对控制器使用 @Tag

    @Tag(name = "User", description = "User 接口")
    
  • 对接口使用 @Operation

    @Operation(description = "分页查询用户信息")
    
  • 完整示例

    @Tag(name = "User", description = "User 接口")
    @RestController
    @RequestMapping("/demo/user")
    public class UserController {
        @Autowired
        private IUserService userService;
    
        @GetMapping("/{page}/{pageSize}")
        @Operation(description = "分页查询用户信息")
        public IPage<User> pageQuery(@PathVariable Integer page, @PathVariable Integer pageSize) {
            return userService.pageQuery(page, pageSize);
        }
    }
    
  • 效果
    在这里插入图片描述

文章来源:https://blog.csdn.net/m0_52733659/article/details/135427014
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。