ubuntu swagger UI如何使用 - 问答

Swagger UI是一个用于描述、生成、消费和可视化RESTful web服务的工具。在Ubuntu上使用Swagger UI通常涉及以下几个步骤：

安装Swagger：首先，你需要在你的Spring Boot项目中添加Swagger依赖。如果你使用的是Maven，可以在pom.xml文件中添加以下依赖：

<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>

如果你使用的是Gradle，可以在build.gradle文件中添加以下依赖：

implementation 'io.springfox:springfox-swagger2:2.9.2'
implementation 'io.springfox:springfox-swagger-ui:2.9.2'

配置Swagger：接下来，你需要配置Swagger。创建一个配置类，使用@EnableSwagger2注解启用Swagger，并定义API文档的路径。

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.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

访问Swagger UI：配置完成后，你可以通过访问http://localhost:8080/swagger-ui.html来查看和使用Swagger UI。如果你的应用程序运行在不同的端口，请确保将端口号替换为实际的端口号。

请注意，Swagger UI的使用需要谨慎，因为它可能会暴露你的API文档，如果配置不当，可能会导致安全风险。例如，未安全配置的Swagger-UI接口可能会受到跨站脚本攻击（XSS），导致敏感信息泄露和账户接管。因此，建议始终在安全的网络环境中使用Swagger UI，并采取适当的安全措施来保护你的API文档。

0 赞

0 踩