spring boot swagger集成

2023/6/6 java

# 1.安装依赖

官网 (opens new window)

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.0.2</version>
</dependency>

# 2. swagger配置类

config目录下OpenApiConfig.java

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class OpenApiConfig {
    @Bean
    public OpenAPI springDocOpenAPI() {
        return new OpenAPI().info(new Info()
                .title("API 文档")
                .description("接口文档说明")
                .version("v0.0.1-SNAPSHOT"));
    }
}

链接 http://localhost:8001/swagger-ui/index.html (opens new window)

# 3.使用

@Operation(summary="登录接口",description="密码至少6位")