Swagger2结合SpringBoot的

引入依赖

swagger2必须要引入springfox-swagger2、springfox-swagger-ui这两个依赖

```xml
<!--swagger依赖   -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<!--swagger ui-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

创建配置类

### 创建配置类

```java
import com.google.common.base.Predicates;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()

                .paths(Predicates.not(PathSelectors.regex("/error.*")))
//                .apis(RequestHandlerSelectors.basePackage("com.it"))
                .build();
    }
    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("网站-中心API文档")
                .description("本文档描述了接口定义")
                .version("1.0")
                .contact(new Contact("hello", "https://blog.csdn.net/u013010499",
                        "6666666666@qq.com"))
                .build();
    }
}

这样swagger就配置完成了,接下来是使用方式

使用

在entity实体类上使用

@Data
public class User {
    @ApiModelProperty(value = "id")
    private String id;
    @ApiModelProperty(value = "用户名")
    private String userName;
    @ApiModelProperty(value = "年龄")
    private int age;
}

在controller实体类上使用

package com.it.controller;

import com.it.entity.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

@Api(tags = "欢迎来到")
@RestController
@RequestMapping("/hello")
public class swaggerController {

    @ApiOperation(value = "写在方法上的1")
    @GetMapping("/getTest")
    public User get(User user){
        return user;
    }

    @PostMapping("post")
    public User post(User user){
        return user;
    }

    @DeleteMapping("delete")
    public User delete(User user)
    {
        return user;
    }

    @PutMapping ("put")
    public User put(User user)
    {
        return user;
    }

}

访问地址

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

图示

image-20211010153035258

输入内容后,点击try it out ,即可得到结果

image-20211010153143189
posted @ 2021-12-12 18:26  任硕  阅读(107)  评论(0)    收藏  举报