SpringBoot＋Swagger-ui自动生成API文档

以下是“SpringBoot＋Swagger-ui自动生成API文档”的完整攻略，包含两个示例说明。

简介

Swagger是一个流行的API文档生成工具，可以帮助开发人员快速生成API文档。本教程将介绍如何在SpringBoot应用程序中使用Swagger-ui自动生成API文档，并提供相应的示例说明。

步骤1：添加Swagger依赖

在SpringBoot应用程序中，可以使用Swagger依赖来生成API文档。在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>

步骤2：配置Swagger

在SpringBoot应用程序中，可以使用@EnableSwagger2注解启用Swagger，并使用@Configuration注解配置Swagger。在SwaggerConfig类中添加以下配置：

@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();
    }
}

在这个示例中，我们使用@EnableSwagger2注解启用Swagger，并使用@Configuration注解配置Swagger。我们创建了一个名为api的Docket对象，并使用basePackage方法指定要扫描的包。我们还使用any方法指定要包含的路径。

示例1：使用@RestController注解生成API文档

以下是一个使用@RestController注解生成API文档的示例：

@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping("/{id}")
    public User findById(@PathVariable Long id) {
        // 根据id查找用户
        return user;
    }

    @PostMapping
    public User save(@RequestBody User user) {
        // 保存用户
        return user;
    }

    @PutMapping("/{id}")
    public User update(@PathVariable Long id, @RequestBody User user) {
        // 更新用户
        return user;
    }

    @DeleteMapping("/{id}")
    public void deleteById(@PathVariable Long id) {
        // 根据id删除用户
    }
}

在这个示例中，我们创建了一个名为UserController的控制器，并使用@RestController注解将其标记为RESTful控制器。我们使用@GetMapping、@PostMapping、@PutMapping和@DeleteMapping注解定义了一些常见的RESTful方法。

示例2：使用@RequestMapping注解生成API文档

以下是一个使用@RequestMapping注解生成API文档的示例：

@Controller
@RequestMapping("/users")
public class UserController {
    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    @ResponseBody
    public User findById(@PathVariable Long id) {
        // 根据id查找用户
        return user;
    }

    @RequestMapping(value = "", method = RequestMethod.POST)
    @ResponseBody
    public User save(@RequestBody User user) {
        // 保存用户
        return user;
    }

    @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
    @ResponseBody
    public User update(@PathVariable Long id, @RequestBody User user) {
        // 更新用户
        return user;
    }

    @RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
    @ResponseBody
    public void deleteById(@PathVariable Long id) {
        // 根据id删除用户
    }
}

在这个示例中，我们创建了一个名为UserController的控制器，并使用@Controller注解将其标记为控制器。我们使用@RequestMapping注解定义了一些常见的RESTful方法。

步骤3：启动应用程序

在终端中执行以下命令，启动SpringBoot应用程序：

mvn spring-boot:run

现在，您可以在浏览器中访问以下URL，查看自动生成的API文档：

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