linux

如何在Linux上配置Swagger以支持HTTPS

小樊
48
2025-07-13 02:57:59
栏目: 智能运维

在Linux上配置Swagger以支持HTTPS,你需要完成以下几个步骤:

  1. 生成SSL证书: 你可以使用OpenSSL来生成自签名证书。以下是一个简单的命令示例:

    openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes
    

    这将生成两个文件:cert.pem(证书)和key.pem(私钥)。

  2. 配置Swagger: 假设你使用的是Spring Boot和Springfox Swagger,你需要在application.propertiesapplication.yml中配置SSL。

    application.properties:

    server.port=8443
    server.ssl.key-store=classpath:keystore.jks
    server.ssl.key-store-password=password
    server.ssl.key-alias=tomcat
    

    application.yml:

    server:
      port: 8443
      ssl:
        key-store: classpath:keystore.jks
        key-store-password: password
        key-alias: tomcat
    

    你需要将生成的cert.pemkey.pem转换为Java KeyStore格式。可以使用以下命令:

    keytool -import -alias tomcat -file cert.pem -keystore keystore.jks -storepass password
    

    系统会提示你输入密钥库密码,输入你之前设置的密码即可。

  3. 配置Swagger: 在你的Spring Boot应用中,配置Swagger以使用HTTPS。以下是一个简单的Swagger配置示例:

    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    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.example.demo"))
                    .paths(PathSelectors.any())
                    .build();
        }
    }
    
  4. 启动应用: 启动你的Spring Boot应用,访问https://localhost:8443/swagger-ui.html,你应该能够看到Swagger UI界面,并且它将通过HTTPS提供服务。

请注意,自签名证书在生产环境中不被推荐使用,因为它不会被浏览器信任。在生产环境中,你应该使用由受信任的证书颁发机构(CA)签发的证书。

0
看了该问题的人还看了