Swagger UI 本身并不提供直接的本地化功能,但你可以通过以下几种方法来实现 Swagger UI 在 Ubuntu 上的本地化:
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:
title: Sample API
description: A sample API to demonstrate Swagger UI integration
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
name:
type: string
node app.js
打开浏览器并访问 http://localhost:3000/api-docs,你应该能看到 Swagger UI 界面。
sudo apt update
sudo apt install docker.io
docker pull swaggerapi/swagger-ui-express
docker run -p 8080:8080 swaggerapi/swagger-ui-express
打开浏览器并访问 http://localhost:8080,你应该能看到 Swagger UI 界面。
通过以上步骤,你可以在 Ubuntu 上成功集成 Swagger UI,并查看和测试你的 API 文档。如果在安装过程中遇到问题,可以参考相关的官方文档或社区论坛寻求帮助。