Spring-Boot-21-Swagger2

最新推荐文章于 2024-07-23 21:37:49 发布

SpriCoder

最新推荐文章于 2024-07-23 21:37:49 发布

阅读量522

点赞数

分类专栏： Spring Boot 文章标签： spring java 后端

本文链接：https://blog.csdn.net/qq_44202160/article/details/124768236

版权

Spring Boot 专栏收录该内容

21 篇文章 5 订阅

订阅专栏

Spring Swagger2

这部分是用来完成动态的生成前后端的API接口文档，保证开发高效

1. pom.xml的依赖

<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>

1.1. 添加配置类

我们建立swaggerConfig类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket customDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("包名"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        Contact contact = new Contact("团队名", "www.my.com", "my@my.com");
        return new ApiInfoBuilder()
                .title("文档标题")
                .description("文档描述")
                .contact(contact)   // 联系方式
                .version("1.1.0")  // 版本
                .build();
    }
}

1.2. 使用swagger2注释方法

package ns.mental.advi.controller;


import io.swagger.annotations.*;
import ns.mental.advi.entity.UserEntity;
import ns.mental.advi.service.impl.UserServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
@RequestMapping("/testBoot")
public class UserController {

    @Autowired
    private UserServiceImpl userService;


    @ApiOperation(value = "查询用户", response = UserEntity.class, httpMethod = "GET" ,notes = "返回一个User对象")
    @RequestMapping("getUser/{id}")
    public String GetUser(@PathVariable int id){
        return userService.SelectByID(id).toString();
    }
}