为了使用Swagger 3,您需要进行以下步骤来将其集成到您的项目中:
- 添加Swagger依赖项:在您的项目的构建文件中,例如pom.xml(如果您的项目是基于Maven),添加Swagger库的依赖项。您可以在Maven中添加以下内容:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
如果您使用Gradle,请在build.gradle文件中添加以下内容:
implementation 'io.springfox:springfox-boot-starter:3.0.0'
-
配置Swagger:在您的Spring Boot主配置类上添加
@EnableSwagger2
或@EnableSwagger2WebMvc
注解。这将启用Swagger在您的应用程序中生成API文档。 -
配置Swagger文档:根据您的应用程序的需求,您可以配置Swagger生成的API文档。您可以为每个控制器配置文档注释,路径选择器和参数注释等。
以下是一个示例控制器的Swagger文档配置:
@Rest