如何用Ubuntu搭建Swagger

在Ubuntu上搭建Swagger主要涉及安装和配置Swagger UI。以下是详细的步骤：

1. 安装Node.js和npm

Swagger UI是一个基于Node.js的应用程序，因此首先需要安装Node.js和npm。

sudo apt update
sudo apt install nodejs npm

验证安装：

node -v
npm -v

2. 安装Swagger UI

你可以使用npm来全局安装Swagger UI。

sudo npm install -g swagger-ui-express

3. 创建一个简单的Express应用

创建一个新的目录并进入该目录：

mkdir swagger-demo
cd swagger-demo

创建一个index.js文件，并添加以下内容：

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');

// Load Swagger document
const swaggerDocument = YAML.load('./swagger.yaml');

const app = express();

// Serve Swagger docs
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

4. 创建Swagger文档

在项目目录中创建一个swagger.yaml文件，并添加你的API文档。以下是一个简单的示例：

swagger: '2.0'
info:
  title: Sample API
  description: A sample API to demonstrate Swagger UI
  version: '1.0.0'
host: localhost:3000
basePath: /api
schemes:
  - http
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
      email:
        type: string
        format: email

5. 运行应用

在项目目录中运行以下命令来启动Express服务器：

node index.js

打开浏览器并访问http://localhost:3000/api-docs，你应该能够看到Swagger UI界面，并且可以测试你的API。

6. 可选：使用Docker部署

如果你更喜欢使用Docker来部署Swagger UI，可以按照以下步骤操作：

1. 安装Docker：

sudo apt update
sudo apt install docker.io

2. 创建一个Dockerfile：

FROM node:14

# Create app directory
WORKDIR /usr/src/app

# Install app dependencies
COPY package*.json ./
RUN npm install

# Bundle app source
COPY . .

EXPOSE 3000
CMD [ "node", "index.js" ]

3. 构建Docker镜像：

docker build -t swagger-ui-express .

4. 运行Docker容器：

docker run -p 3000:3000 swagger-ui-express

现在，你可以通过访问http://localhost:3000/api-docs来查看Swagger UI界面。

通过以上步骤，你就可以在Ubuntu上成功搭建Swagger UI并测试你的API了。