SpringBoot学习笔记：集成swagger2

Posted 2022-12-05 听风者-better

1.添加log4j依赖

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

2.创建swagger配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig 
    @Bean
    public Docket createRestApi()
        return new Docket(DocumentationType.SWAGGER_2).
                apiInfo(apiInfo()).
                select().
                apis(RequestHandlerSelectors.basePackage("com.twy.springbootswagger.controller")).
                paths(PathSelectors.any()).
                build();
    

    private ApiInfo apiInfo()
        return new ApiInfoBuilder().
                title("接口总览").
                description("springboot项目中集成swagger2").
                contact("[e-mail]").
                version("1.0").build();
    

3.创建实列

@ApiModel
public class User 
    @ApiModelProperty(value = "用户id")
    private int id;
    @ApiModelProperty(value = "用户名")
    private String username;
    @ApiModelProperty(value = "用户密码")
    private String password;
    //省略set/get方法

@RestController
@Api
public class UserController 
    @GetMapping("/get/id")
    @ApiOperation("根据用户id获取用户信息")
    public User getUser(@PathVariable @ApiParam(value = "用户id") int id)
        User user = new User();
        user.setId(1);
        user.setUsername("唐万言");
        user.setPassword("123456");
        return user;
    

@ApiModel：注解用于实体类，表示对类进行说明，用于参数用实体类接收。

@ApiModelProperty：注解用于类中属性，表示对 model 属性的说明或者数据操作更改。

@Api：注解用于类上，表示标识这个类是 swagger 的资源。

@ApiOperation：注解用于方法，表示一个 http 请求的操作。

@ApiParam：m 注解用于参数上，用来标明参数信息。

4.访问http://localhost:8080/swagger-ui.html