在Linux上集成Swagger和Spring Boot,你需要遵循以下步骤:
pom.xml
文件中添加Swagger的依赖。对于Spring Boot 2.x,你可以使用springfox-swagger2和springfox-swagger-ui这两个库。<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>
请注意,版本号可能会随着时间而变化,所以请检查最新的版本。
@Configuration
注解,并且要创建一个Docket
类型的Bean。import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.yourpackage")) // 替换为你的控制器包路径
.paths(PathSelectors.any())
.build();
}
}
http://localhost:8080/swagger-ui.html
这里的端口号8080
是Spring Boot应用程序的默认端口,如果你的应用程序运行在不同的端口上,请相应地更改URL。
@ApiOperation
,来提供更多的API信息。然后,你可以使用Swagger UI来测试你的API。import springfox.documentation.annotations.ApiOperation;
@RestController
@RequestMapping("/api")
public class MyController {
@ApiOperation(value = "获取用户信息", notes = "根据用户ID获取用户详细信息")
@GetMapping("/user/{id}")
public User getUserById(@PathVariable Long id) {
// ...
}
}
./mvnw spring-boot:run
确保你有适当的权限来执行这个命令,可能需要使用sudo
。
按照这些步骤,你应该能够在Linux上成功集成Swagger和Spring Boot,并开始为你的RESTful API创建文档和进行测试。