Ubuntu中Swagger命令有哪些

在Ubuntu中，Swagger通常指的是Swagger UI和Swagger Editor，它们是用来生成和测试RESTful API文档的工具。以下是在Ubuntu上安装和配置Swagger的步骤：

安装Swagger UI

更新包列表：

sudo apt update

安装必要的依赖：

sudo apt install -y openjdk-11-jre-headless

下载Swagger UI：

wget https://repo1.maven.org/maven2/io/springfox/springfox-swagger-ui/2.9.2/springfox-swagger-ui-2.9.2.html

解压Swagger UI：

unzip springfox-swagger-ui-2.9.2.html

移动解压后的文件到Web服务目录（例如 /var/www/html）：

sudo mv springfox-swagger-ui-2.9.2 /var/www/html/swagger-ui

配置Swagger UI：编辑 /var/www/html/swagger-ui/index.html 文件，找到以下行并进行修改：

script window.onload function () { // Begin Swagger UI call region const ui = SwaggerUIBundle({ url: "http://petstore.swagger.io/v2/api-docs", dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], layout: "StandaloneLayout" }); // End Swagger UI call region window.ui = ui; };

启动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.backups sudo nano /etc/nginx/sites-available/default

修改 server 块中的 root 和 index 指令：

server { listen 80 default_server; listen [::]: 80 default_server; root /var/www/html; index index.html index.htm; server_name _; location / { try_files $uri $uri/ =404; } }

保存并退出编辑器，然后重启Nginx：

sudo systemctl restart nginx

访问Swagger UI：现在，你应该能够通过浏览器访问 http://your_server_ip/swagger-ui 来查看和使用Swagger UI。

安装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

移动文件到Web服务目录（例如 /var/www/html）：

sudo mv swagger-editor.min.js /var/www/html/swagger-editor.js sudo mv swagger-editor.min.css /var/www/html/swagger-editor.css

创建一个简单的HTML文件来加载Swagger Editor：

sudo nano /var/www/html/swagger-editor.html

添加以下内容：

<!DOCTYPE html> html> <head> <link rel="stylesheet" type="text/css" href="swagger-editor.css"> </head> <body> <div id="swagger-editor"></div> <script src="swagger-editor.js"></script> <script> window.onload = function () { const editor = SwaggerEditor({ url: "https://petstore.swagger.io/v2/api-docs", dom_id: '#swagger-editor' }); }; </script> </body> </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.backups sudo nano /etc/nginx/sites-available/default

修改 server 块中的 root 和 index 指令：

server { listen 80 default_server; listen [::]: 80 default_server; root /var/www/html; index index.html index.htm; server_name _; location / { try_files $uri $uri/ =404; } }

保存并退出编辑器，然后重启Nginx：

sudo systemctl restart nginx

访问Swagger Editor：现在，你应该能够通过浏览器访问 http://your_server_ip/swagger-editor 来查看和使用Swagger Editor。

以上就是在Ubuntu上安装和配置Swagger UI和Swagger Editor的基本步骤。如果在安装过程中遇到问题，可以参考相关的官方文档或社区论坛寻求帮助。

安装Swagger UI

安装Swagger Editor

最新问答

相关标签