Linux系统中Swagger如何进行API文档导出-linux运维-PHP中文网

Linux系统中Swagger如何进行API文档导出

幻夢星雲

发布： 2025-05-22 13:52:43

原创

513人浏览过

在linux系统中，使用swagger导出api文档的步骤如下：

1. 安装Swagger

首先，确保你已经在Linux系统上安装了Swagger。如果你使用的是Spring Boot项目，Swagger通常已经包含在其中。对于其他类型的Java项目，你需要添加Swagger依赖。例如，在Maven项目的pom.xml文件中添加以下依赖：

<<span>dependency></span>
    <<span>groupId></span>io.springfox</<span>groupId></span>
    <<span>artifactId></span>springfox-swagger2</<span>artifactId></span>
    <<span>version></span>2.9.2</<span>version></span>
</<span>dependency></span>
<<span>dependency></span>
    <<span>groupId></span>io.springfox</<span>groupId></span>
    <<span>artifactId></span>springfox-swagger-ui</<span>artifactId></span>
    <<span>version></span>2.9.2</<span>version></span>
</<span>dependency></span>

登录后复制

2. 配置Swagger

在项目中配置Swagger。创建一个Swagger配置类，并使用@EnableSwagger2注解启用Swagger支持。例如：

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;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@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();
    }
}

登录后复制