简介

在软件开发过程中，API文档的编写和维护是一项繁琐且耗时的工作。Swagger的出现，为开发者带来了福音。 我深信... 同过Swagger，我们可依轻松实现API文档的自动化，大大提升开发效率。

安装

在Ubuntu上部署Swagger，先说说需要安装Node.js和npm。

sudo apt update
sudo apt install nodejs npm -y

染后 全局安装Swagger工具：

sudo npm install -g swagger-jsdoc swagger-ui-express

配置

脑子呢？ 安装完成后我们需要配置Swagger。这通常涉及到定义API的YAML文件和配置Swagger UI的路径。

定义API的YAML文件

创建一个名为`swagger.yaml`的文件， 并添加以下内容：，火候不够。

swagger: '2.0'
info:
  title: Sample API
  version: '1.0.0'
paths:
  /users:
    get:
      summary: List all users
      responses:
        '200':
          description: An array of users
          schema:
            type: array
            items:
              $ref: '#/definitions/User'
definitions:
  User:
    type: object
    properties:
      id:
        type: integer
        format: int64
      name:
        type: string
required:
  - id
  - name

配置Swagger UI的路径

在项目根目录下创建一个名为`package.json`的文件，并添加以下内容：，歇了吧...

{
  "name": "swagger-app",
  "version": "1.0.0",
  "description": "Swagger API documentation",
  "main": "app.js",
  "scripts": {
    "start": "swagger-ui-express"
  },
  "dependencies": {
    "swagger-jsdoc": "^2.1.0",
    "swagger-ui-express": "^4.1.0"
  }
}

部署

部署Swagger主要有以下几种方式：

方式一：使用Docker部署

先说说安装Docker：

sudo apt update
sudo apt install apt-transport-https ca-certificates curl gnupg-agent software-properties-common -y
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb  https://download.docker.com/linux/ubuntu $ stable"
sudo apt update
sudo apt install docker-ce docker-ce-cli containerd.io -y

染后使用以下命令拉取Swagger UI的Docker镜像：，不忍卒读。

docker pull swaggerapi/swagger-ui-express

接下来运行Swagger UI容器：

docker run -p 8080:8080 swaggerapi/swagger-ui-express

划水。 现在你可依同过访问 来查堪Swagger UI界面。

方式二：静态站点托管Swagger UI

先说说 克隆Swagger UI仓库：

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

染后将构建的`dist`目录下的内容复制到你的Web服务器目录下比方说：

sudo mkdir -p /var/www/html/swagger-ui
sudo cp -r dist/* /var/www/html/swagger-ui

再说说配置Nginx来托管Swagger UI：

sudo nano /etc/nginx/sites-available/swagger

添加以下内容：

server {
    listen 80;
    server_name your-domain-or-ip;
    location /swagger-ui/ {
        alias /var/www/html/swagger-ui/;
        index index.html index.htm;
    }
}

启用站点并重启Nginx：

sudo ln -s /etc/nginx/sites-available/swagger /etc/nginx/sites-enabled
sudo nginx -t
sudo systemctl reload nginx

现在你可依同过访问 来查堪Swagger UI界面，地道。。

Swagger Editor

如guo你需要使用Swagger Editor，可依使用h 开倒车。 ttp-server托管或将其放入Nginx/Apache。

npm install -g http-server
http-server ./swagger-editor

或着，配置Nginx/Apache来托管Swagger Editor，佛系。。

Docker部署

使用以下命令安装Swagger命令行工具：，瞎扯。

sudo npm install -g swagger-jsdoc swagger-ui-express

docker pull swaggerapi/swagger-ui-express

docker run -d --name swagger-editor -p 8080:8080 swaggerapi/swagger-editor:latest

docker run -d --name swagger-ui -p 8081:8080 \ -v $/:/usr/share/nginx/html/ \ swaggerapi/swagger-ui:latest

访问Editor在 ，UI在 。

常见问题与优化

捡漏。 问题 解决方案 无法拉取Docker镜像 检查Docker的配置，确保网络连接正常。 Swagger UI无法访问 检查Nginx/Apache的配置，确保路径正确。 Swagger Editor无法启动 确保http-server或Nginx/Apache以正确配置。 同过以上方法， 你可依在Ubuntu上轻松部署Swagger，实现API文档的自动化，提升开发效率。 版权所you © 2021 Swagger部署指南

---