在Ubuntu上部署Swagger(现称为OpenAPI)有多种方法,以下是两种常见的方法:
sudo apt update
sudo apt install docker.io
docker pull swaggerapi/swagger-ui-express
docker run -p 8080:8080 swaggerapi/swagger-ui-express
sudo apt update
sudo apt install nodejs npm
mkdir swagger-ui-project
cd swagger-ui-project
npm init -y
npm install swagger-ui-express
app.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}`);
});
swagger.yaml
的文件,并添加你的API文档。例如:swagger: '2.0'
info:
version: '1.0.0'
title: Sample API
description: A sample API to demonstrate Swagger on Ubuntu
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
node app.js
以上方法可以帮助您在Ubuntu上成功集成并运行Swagger UI。请根据您的需求和环境选择合适的方法。