springboot基础4（openAPI(swagger3)）_openapi 规范 springboot

1、介绍

​ Swagger 是一个 RESTful API 的开源框架，它的主要目的是帮助开发者设计、构建、文档化和测试 Web API。

​ OpenAPI规范最初由开发Swagger的团队在2010年推出，从Swagger 2.0开始，Swagger规范被正式更名为OpenAPI规范，并得到了许多社区的支持和贡献

2、依赖

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>2.0.2</version>
  <exclusions>
    <exclusion>
      <artifactId>slf4j-api</artifactId>
      <groupId>org.slf4j</groupId>
    </exclusion>
  </exclusions>
</dependency>
1
2
3
4
5
6
7
8
9
10
11

3、swagger页面

​ 本地页面：http://localhost:8080/swagger-ui.html

4、SwaggerConfig

@Configuration
public class SwaggerConfig {
    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("标题")
                        .description("这是描述")
                        .version("这是版本")
                        .license(new License().name("Apache 2.0").url("#")))
                .externalDocs(new ExternalDocumentation()
                        .description("外部文档")
                        .url("#"));//外部文档链接
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

访问swagger

测试controller

@RestController
@Tag(name = "测试Controller（test）", description = "这是描述")
public class HelloController {

    @GetMapping("test")
    @Operation(summary = "测试接口hello1")
    public String hello1(@Parameter(name = "name", description = "hello1的参数名称")String name){
        return "Hello"+name;
    }
}
1
2
3
4
5
6
7
8
9
10

可以直接在前端输入参数进行测试

5、注解解释

引用博客：Swagger3 注解使用（Open API 3）_swagger3注解-CSDN博客