springboot整合swagger小栗子

你的名字 2022-12-17 07:10 64阅读 0赞

## 1：POM ##

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.10.RELEASE</version>
        <relativePath/> 
      </parent>
      <groupId>dongshi.daddy</groupId>
      <artifactId>springboot-swagger-demo</artifactId>
      <version>0.0.1-SNAPSHOT</version>
      <name>springboot-swagger-demo</name>
      <description>Demo project for Spring Boot</description>
    
      <properties>
        <java.version>1.8</java.version>
      </properties>
    
      <dependencies>
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-test</artifactId>
          <scope>test</scope>
          <exclusions>
            <exclusion>
              <groupId>org.junit.vintage</groupId>
              <artifactId>junit-vintage-engine</artifactId>
            </exclusion>
          </exclusions>
        </dependency>
        <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger-ui</artifactId>
          <version>2.6.1</version>
        </dependency>
        <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger2</artifactId>
          <version>2.6.1</version>
        </dependency>
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
          <groupId>mysql</groupId>
          <artifactId>mysql-connector-java</artifactId>
        </dependency>
      </dependencies>
    
      <build>
        <plugins>
          <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
          </plugin>
        </plugins>
      </build>
    </project>

## 2：controller ##

@RequestMapping("/user")
    @RestController
    public class UserController { 
        @Autowired
        UserService userService;
    
        @GetMapping("/{username}")
        @ResponseBody
        public User getUser(@PathVariable("username") String username) { 
            System.out.println("username is: " + username);
            return userService.findUserByName(username);
        }
    
        @ApiOperation(value = "用户列表_value", notes = "用户列表_notes")
        @RequestMapping(value = { "/user_list"}, method = RequestMethod.GET)
        public List<User> getUsers() { 
            List<User> users = userService.findAll();
            return users;
        }
    
        @ApiOperation(value = "创建用户_value", notes = "创建用户_notes")
        @RequestMapping(value = { "user_save"}, method = RequestMethod.POST)
        public User postUser(@RequestBody User user) { 
            return userService.saveUser(user);
        }
    
        @ApiIgnore // 代表忽略这个API
        @RequestMapping(value = { "/hi"}, method = RequestMethod.GET)
        public String jsonTest() { 
            return "hi you!";
        }
    }

## 3：启动测试 ##

访问`http://ip:port/swagger-ui.html`：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center]

## 4：源码 ##

[这里][Link 1]。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/7755b596a9234678a8b946523044c5a2.png
[Link 1]: https://download.csdn.net/download/wang0907/13010830