Spring Boot Starter Swagger 使用教程

最新推荐文章于 2024-08-20 09:03:54 发布

凌萍鹃Dillon

最新推荐文章于 2024-08-20 09:03:54 发布

阅读量651

点赞数 20

本文链接：https://blog.csdn.net/gitblog_00675/article/details/141044451

版权

Spring Boot Starter Swagger 使用教程

spring-boot-starter-swagger自制spring boot starter for swagger 2.x，来试试吧，很好用哦~项目地址:https://gitcode.com/gh_mirrors/sp/spring-boot-starter-swagger

项目介绍

spring-boot-starter-swagger 是一个基于 Swagger 的 Spring Boot Starter，旨在简化在 Spring Boot 应用中集成 Swagger 的过程。Swagger 是一个用于生成、描述、调用和可视化 RESTful 风格 Web 服务的工具。通过使用 spring-boot-starter-swagger，开发者可以快速地在 Spring Boot 项目中生成 API 文档，而无需进行复杂的配置。

项目快速启动

引入依赖

首先，在您的 Spring Boot 项目的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>2.0.2.RELEASE</version>
</dependency>

配置 Swagger

在 application.properties 或 application.yml 文件中添加 Swagger 的基本配置：

# swagger配置
swagger.title=对外开放接口API文档
swagger.description=HTTP对外开放接口
swagger.version=1.0.0
swagger.license=Apache License Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html

启动应用

完成上述配置后，启动您的 Spring Boot 应用。Swagger 文档将自动生成，并通过以下路径访问：

http://localhost:8080/swagger-ui.html

应用案例和最佳实践

案例一：用户管理接口

假设我们有一个简单的用户管理接口，包括用户创建、查询和删除功能。以下是一个示例控制器：

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/users")
@Api(tags = "用户管理接口")
public class UserController {

    @PostMapping
    @ApiOperation("创建用户")
    public String createUser(@RequestBody User user) {
        // 创建用户的逻辑
        return "User created";
    }

    @GetMapping("/{id}")
    @ApiOperation("查询用户")
    public User getUser(@PathVariable Long id) {
        // 查询用户的逻辑
        return new User();
    }

    @DeleteMapping("/{id}")
    @ApiOperation("删除用户")
    public String deleteUser(@PathVariable Long id) {
        // 删除用户的逻辑
        return "User deleted";
    }
}