当前位置：首页 > 文章列表 > 文章 > linux > Linux下Swagger配置指南

Linux下Swagger配置指南

2025-02-26 23:51:25 0浏览收藏

本文详细介绍了在Linux环境下配置Swagger的三种方法：使用Docker容器部署（推荐）、使用npm安装以及Spring Boot集成。Docker方法简化了安装过程，避免了依赖管理的复杂性，只需几条命令即可运行Swagger UI和Swagger Editor。npm方法适用于需要更精细化控制的场景，需要预先安装Node.js和npm。对于Spring Boot项目，推荐使用Springdoc OpenAPI集成Swagger，方便快捷。无论哪种方法，都能帮助您快速搭建Swagger环境，提升API文档管理和测试效率，提高开发效率。关键词：Swagger, Linux, Docker, npm, Spring Boot, API文档, 配置教程

Swagger在Linux环境下如何配置

本文介绍如何在Linux环境下配置Swagger，主要涵盖Swagger UI和Swagger Editor的安装与配置。

一、使用Docker容器部署 (推荐)

此方法简化了安装过程，避免了依赖管理的复杂性。

安装Docker: 若未安装Docker，请执行以下命令：

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

拉取镜像: 分别拉取Swagger UI和Swagger Editor镜像：
```
docker pull swaggerapi/swagger-ui:latest
docker pull swaggerapi/swagger-editor:latest
```
(使用 latest 标签获取最新版本)
运行容器: 运行Swagger UI和Swagger Editor容器，并映射端口：
```
docker run -d -p 8080:8080 swaggerapi/swagger-ui:latest
docker run -d -p 8081:8080 swaggerapi/swagger-editor:latest
```
访问 http://<你的服务器IP>:8080 查看Swagger UI，访问 http://<你的服务器IP>:8081 查看Swagger Editor。

二、使用npm安装 (适用于需要更精细控制的情况)

此方法需要预先安装Node.js和npm。

安装Node.js和npm: 使用以下命令安装：

curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -  # 使用16.x版本或其他稳定版本
sudo apt-get install -y nodejs

安装依赖: 安装Express和http-server:
```
npm install -g express http-server
```

安装Swagger UI:

git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
npm install
http-server -p 8080

安装Swagger Editor:
```
git clone https://github.com/swagger-api/swagger-editor.git
cd swagger-editor
npm install
http-server -p 8081
```
同样，访问 http://<你的服务器IP>:8080 查看Swagger UI，访问 http://<你的服务器IP>:8081 查看Swagger Editor。

三、 Spring Boot集成Swagger (适用于Spring Boot项目)

对于Spring Boot项目，推荐使用Springdoc OpenAPI来集成Swagger。

添加依赖: 在 pom.xml 文件中添加依赖：

org.springdocspringdoc-openapi-starter-webmvc-ui2.1.0

配置Swagger (可选): 可以创建一个配置类来自定义Swagger文档信息：

import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SwaggerConfig {
    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
                .group("public")
                .pathsToMatch("/public/**")
                .build();
    }
}