Day56_SwaggerUI

原创

已于 2023-11-12 12:04:08 修改 · 5.6k 阅读

13 ·

CC 4.0 BY-SA版权

文章标签：

#Word #csdn #spring boot

于 2021-11-29 09:37:10 首次发布

本文详细介绍了如何在SpringBoot项目中集成Swagger，包括添加依赖、配置基本信息、扫描包路径、自定义注解排除及API注解详解。通过实例演示了如何定制Swagger UI界面，实现接口文档的精准控制。

文章目录

一、Swagger极致用法

1 编写SpringBoot项目

编写SpringBoot项目，项目中controller中包含一个Handler，测试项目，保证程序可以正确运行。

@RestController
@RequestMapping("/people")
public class DemoController {
   
   

    @RequestMapping("/getPeople")
    public People getPeople(Long id, String name){
   
   
        People peo = new People();
        peo.setId(id);
        peo.setName(name);
        peo.setAddress("海淀");
        return peo;
    }
}
12345678910111213

2 导入Spring-fox依赖

在项目的pom.xml中导入Spring-fox依赖。目前最新版本为2.9.2，所以导入的依赖也是这个版本。其中springfox-swagger2是核心内容的封装。springfox-swagger-ui是对swagger-ui的封装。

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

1234567891011

3 添加注解

在SpringBoot的启动类中添加@EnableSwagger2注解。
添加此注解后表示对当前项目中全部控制器进行扫描。应用Swagger2

@SpringBootApplication
@EnableSwagger2
public class MyApp {
   
   
    public static void main(String [] args){
   
   
        SpringApplication.run(MyApp.class,args);