Swagger在Linux环境下如何配置

在Linux环境下配置Swagger，通常是指安装和配置Swagger UI和Swagger Editor。以下是详细的步骤：

安装Swagger UI和Swagger Editor

使用Docker容器部署

1. 安装Docker（如果尚未安装）：

   sudo apt-get update
   sudo apt-get install -y docker.io
   sudo systemctl start docker
   sudo systemctl enable docker
   

   复制代码

2. 拉取Swagger UI镜像：

   docker pull swaggerapi/swagger-ui:v4.6.0
   

   复制代码

3. 拉取Swagger Editor镜像：

   docker pull swaggerapi/swagger-editor:v4.6.0
   

   复制代码

4. 运行Swagger UI容器：

   docker run -d -p 38080:8080 swaggerapi/swagger-ui:v4.6.0
   

   复制代码

5. 运行Swagger Editor容器：

   docker run -d -p 38081:8080 swaggerapi/swagger-editor:v4.6.0
   

   复制代码

   现在，你可以通过访问 http://<your-server-ip>:38080 来查看Swagger UI，通过访问 http://<your-server-ip>:38081 来查看Swagger Editor。

使用npm安装

1. 安装Node.js和npm（如果尚未安装）：

   curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
   sudo apt-get install -y nodejs
   

   复制代码

2. 安装Express：

   npm install -g express
   

   复制代码

3. 安装http-server：

   npm install -g http-server
   

   复制代码

4. 下载并解压Swagger UI：

   git clone https://github.com/swagger-api/swagger-ui.git
   cd swagger-ui
   npm install
   

   复制代码

5. 启动Swagger UI：

   http-server -p 8080
   

   复制代码

6. 下载并解压Swagger Editor：

   git clone https://github.com/swagger-api/swagger-editor.git
   cd swagger-editor
   npm install
   

   复制代码

7. 启动Swagger Editor：

   http-server -p 8081
   

   复制代码

   现在，你可以通过访问 http://<your-server-ip>:8080 来查看Swagger UI，通过访问 http://<your-server-ip>:8081 来查看Swagger Editor。

配置Swagger

使用Spring Boot集成Swagger（适用于Spring Boot项目）

1. 添加依赖： 在 pom.xml 中添加以下依赖：

   <dependency>
       <groupId>org.springdoc</groupId>
       <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
       <version>2.1.0</version>
   </dependency>
   

   复制代码

2. 配置Swagger： 创建一个配置类：

   import io.swagger.v3.oas.annotations.OpenAPIDefinition;
   import io.swagger.v3.oas.annotations.info.Info;
   import org.springframework.context.annotation.Bean;
   import org.springframework.context.annotation.Configuration;
   
   @Configuration
   @OpenAPIDefinition(info = @Info(title = "My API", version = "1.0"))
   public class SwaggerConfig {
   
       @Bean
       public Docket api() {
           return new Docket(DocumentationType.OAS_30)
                   .select()
                   .apis(RequestHandlerSelectors.any())
                   .paths(PathSelectors.any())
                   .build();
       }
   }
   

   复制代码

3. 启动应用： 启动你的Spring Boot应用，然后访问 http://<your-server-ip>:8080/swagger-ui/ 查看Swagger文档。

通过以上步骤，你可以在Linux环境下成功配置和运行Swagger UI和Swagger Editor。

亿速云「云服务器」，即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘，价格低至29元/月。点击查看>>