linux

如何在Linux中使用Swagger进行API文档离线查看

小樊
31
2025-02-23 07:12:37
栏目: 智能运维

在Linux中使用Swagger进行API文档离线查看,可以按照以下步骤进行:

1. 安装Swagger

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

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.14</version>
</dependency>

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

implementation 'org.springdoc:springdoc-openapi-ui:1.6.14'

2. 配置Swagger

在你的Spring Boot应用中配置Swagger。你可以创建一个配置类,使用@EnableSwagger2注解来启用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();
    }
}

3. 生成API文档

在添加了Swagger依赖并配置好Swagger之后,你可以通过访问/swagger-ui.html路径来查看生成的API文档。由于你已经将Swagger集成到了Spring Boot应用中,因此不需要手动下载Swagger的静态文件。

4. 离线查看API文档

为了离线查看API文档,你可以将整个Spring Boot应用打包成一个可执行的JAR文件。这样,你就可以在任何Linux环境中运行这个JAR文件,并通过浏览器访问http://localhost:8080/swagger-ui.html来查看API文档。

例如,你可以使用以下命令来打包和运行你的Spring Boot应用:

# 打包成JAR文件
mvn clean package

# 运行JAR文件
java -jar target/your-application-name.jar

通过以上步骤,你就可以在Linux中使用Swagger进行API文档的离线查看了。

0
看了该问题的人还看了