SpringBoot2.7+使用swagger3

最新推荐文章于 2025-04-09 10:47:02 发布

简明编程

最新推荐文章于 2025-04-09 10:47:02 发布

阅读量4.5k

点赞数 4

CC 4.0 BY-SA版权

分类专栏：笔记微服务与中间件 # SpringCloud 文章标签： java spring spring boot

本文链接：https://blog.csdn.net/qq_51553982/article/details/126280493

SpringBoot2.7+使用swagger3

SpringBoot2.7+使用swagger3
借助Knife4j增强

SpringBoot2.7+使用swagger3

1.依赖导入

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

2.编写Controller配合Swagger注解

package com.example.swagger3.controller;

import com.example.swagger3.entity.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/user")
@Api(tags = "用户控制器")
public class UserController {
   
   

    @GetMapping("/test")
    @ApiOperation(value = "获取用户信息")
    public User getUser(){
   
   
        User user = new User();
        user.setUsername("zhangsan");
        user.setPassword("sjdakjd");
        return user;
    }

    @PostMapping("/test2")
    @ApiOperation(value = "展示post")
    public User show(){
   
   
        User user = new User();
        user.setUsername("lisi");
        user.setPassword("sasdsad");
        return user;
    }

}

3.编写swagger配置类

package com.example.swagger3.config;

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration