在Linux系统中安装Swagger,通常是指安装Swagger UI和Swagger Editor。以下是详细的安装步骤:
安装Swagger Editor
-
安装Node.js和npm:
- 更新包列表:
sudo apt update
- 安装必要的依赖:
sudo apt install -y openjdk-11-jre-headless
- 下载并安装Node.js和npm:
wget https://nodejs.org/dist/v16.14.0/node-v16.14.0-linux-x64.tar.xz tar -xvf node-v16.14.0-linux-x64.tar.xz sudo mv node-v16.14.0-linux-x64 /usr/local/nodejs
- 配置Node.js和npm全局路径:
echo 'export PATH=/usr/local/nodejs/bin:$PATH' >> ~/.bashrc source ~/.bashrc
- 验证安装:
node -v npm -v
- 更新包列表:
-
下载并安装Swagger Editor:
- 下载Swagger Editor:
wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.js wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.css
- 创建一个简单的HTML文件来加载Swagger Editor:
sudo nano /usr/local/nodejs/swagger-editor.html
- 添加以下内容:
- 启动Web服务器(例如Apache或Nginx):
- Apache:
sudo a2ensite default.conf sudo systemctl restart apache2
- Nginx:
sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.backup sudo nano /etc/nginx/sites-available/default
修改server
块中的root
和index
指令:server { listen 80 default_server; listen [::]: 80 default_server; root /usr/local/nodejs; index index.html index.htm; server_name _; location / { try_files $uri $uri/ =404; } }
保存并退出编辑器,然后重启Nginx:sudo systemctl restart nginx
- Apache:
- 下载Swagger Editor:
-
访问Swagger Editor:
- 打开浏览器,访问:
http://your_server_ip/swagger-editor
- 打开浏览器,访问:
安装Swagger UI(适用于Spring Boot项目)
-
添加依赖:
- 在项目的
pom.xml
文件中添加以下依赖:io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2
- 在项目的
-
配置Swagger:
- 创建一个配置类来启用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.any()) .paths(PathSelectors.any()) .build(); } }
- 创建一个配置类来启用Swagger并定义一些基本信息:
-
访问Swagger UI:
- 启动Spring Boot项目后,访问:
http://localhost:8080/swagger-ui.html
- 启动Spring Boot项目后,访问:
通过以上步骤,你可以在Linux系统中成功安装并配置Swagger UI和Swagger Editor。