简介
描述Swagge2的相关配置,同时以该项目为蓝本,作为以后项目搭建排错的依据
介绍
Swagger 是一个用于描述和记录 RESTful API 的项目。
Swagger 规范定义了一组描述此类 API 所需的文件。然后,Swagger-UI 项目可以使用这些文件来显示 API,并使用 Swagger-Codegen 生成各种语言的客户端。其他实用程序也可以利用生成的文件,例如测试工具。
本项目基于SpringBoot项目+web服务
初识Swagger2
导入依赖
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
新建配置类
import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* TODO
*
* @author ben
* @version 1.0
* @date 2022/9/13 11:23
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
}
启动项目
访问:http://127.0.0.1:8080/swagger-ui.html#/
来到此页面
好了,目前你已经初步了解了Swagger2!下一节将继续深入剖析Swagger2。