在CentOS系統上自定義Swagger配置,通常涉及以下幾個步驟:
首先,確保你的CentOS系統已經安裝了必要的依賴包。你可以使用以下命令來安裝:
sudo yum install -y java-1.8.0-openjdk-devel maven
在你的Spring Boot項目的pom.xml
文件中添加Swagger依賴:
<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>
創建一個配置類來配置Swagger。例如,創建一個名為SwaggerConfig.java
的文件:
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
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)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.yourpackage.controller")) // 替換為你的控制器包路徑
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Your API Title")
.description("Your API Description")
.version("1.0.0")
.build();
}
}
如果你想自定義Swagger UI的外觀和行為,可以在application.properties
或application.yml
文件中添加配置。例如:
springfox.documentation.swagger.v2.path=/v2/api-docs
springfox.documentation.swagger-ui.base-url=/swagger-ui.html
springfox:
documentation:
swagger:
v2:
path: /v2/api-docs
swagger-ui:
base-url: /swagger-ui.html
啟動你的Spring Boot應用,然后訪問http://<your-server-address>:<port>/swagger-ui.html
來查看Swagger UI界面。
如果你需要更高級的自定義,可以考慮以下幾點:
通過以上步驟,你應該能夠在CentOS系統上成功自定義Swagger配置。