centos

centos swagger自定义配置

小樊
35
2025-04-02 19:18:00
栏目: 智能运维

在CentOS系统上自定义Swagger配置,通常涉及以下几个步骤:

1. 安装Swagger相关依赖

首先,确保你的CentOS系统已经安装了必要的依赖包。你可以使用以下命令来安装:

sudo yum install -y java-1.8.0-openjdk-devel maven

2. 添加Swagger依赖

在你的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>

3. 配置Swagger

创建一个配置类来配置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();
    }
}

4. 自定义Swagger UI

如果你想自定义Swagger UI的外观和行为,可以在application.propertiesapplication.yml文件中添加配置。例如:

application.properties

springfox.documentation.swagger.v2.path=/v2/api-docs
springfox.documentation.swagger-ui.base-url=/swagger-ui.html

application.yml

springfox:
  documentation:
    swagger:
      v2:
        path: /v2/api-docs
      swagger-ui:
        base-url: /swagger-ui.html

5. 启动应用

启动你的Spring Boot应用,然后访问http://<your-server-address>:<port>/swagger-ui.html来查看Swagger UI界面。

6. 进一步自定义

如果你需要更高级的自定义,可以考虑以下几点:

通过以上步骤,你应该能够在CentOS系统上成功自定义Swagger配置。

0
看了该问题的人还看了