如何在Linux系统中使用Swagger进行API文档共享

在Linux系统中使用Swagger进行API文档共享，可以按照以下步骤进行：

安装Node.js和npm

首先，需要在Linux服务器上安装Node.js和npm。可以通过以下命令进行安装：

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

安装Swagger Editor和Swagger UI

下载并解压Swagger Editor和Swagger UI：

wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.50.0.tar.gz
tar -xvf swagger-editor-3.50.0.tar.gz
cd swagger-editor-3.50.0

wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.50.0.tar.gz
tar -xvf swagger-ui-3.50.0.tar.gz
cd swagger-ui-3.50.0

启动Swagger Editor和Swagger UI：

npm install -g http-server
http-server -p 8080 # 启动Swagger Editor
http-server -p 8081 # 启动Swagger UI

现在，可以通过浏览器访问 http://your_server_ip:8080 来使用Swagger Editor，访问 http://your_server_ip:8081 来使用Swagger UI。

集成Swagger到Spring Boot项目（可选）

如果你使用的是Spring Boot项目，可以集成Swagger来自动生成API文档。添加相关依赖并配置Swagger：

在 pom.xml 中添加依赖：

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

配置 application.properties 文件：

springdoc.api-docs.path=/api-docs
springdoc.swagger-ui.path=/swagger-ui

启动Spring Boot应用后，访问 http://your_server_ip:8080/swagger-ui 即可查看生成的API文档。

远程访问Swagger Editor（可选）

可以使用Docker和Cpolar来实现Swagger Editor的远程访问：

部署Swagger Editor Docker：

docker pull swaggerapi/swagger-editor
docker run -p 8088:8080 -d swaggerapi/swagger-editor

使用Cpolar实现远程访问：

安装Cpolar并配置内网穿透，在Swagger Editor容器中配置公网地址，使用Cpolar生成的公网地址进行远程访问。

使用Swagger API文档共享

• Swagger API 文档生成：开发者通过定义 API 的 OpenAPI 规范文件(通常为 JSON 或 YAML 格式), Swagger 工具就能根据这些规范自动生成交互式的 API 文档。
• Swagger UI：Swagger UI 是 Swagger 工具集中的一个组件, 它负责将 OpenAPI 规范文件呈现为人性化的 Web 页面。用户可以通过 Swagger UI 查看和测试 API 的所有接口, 这使得 API 的使用和测试更加直观和方便。
• GitHub Pages：GitHub Pages 是一个免费的静态站点托管服务, 允许用户直接从 GitHub 仓库发布网站内容。开发者可以利用 GitHub Pages 展示个人或项目的介绍页面、博客或者文档。

通过以上步骤，可以在Linux系统中成功部署和使用Swagger进行API文档共享。