以下是在Debian系统上安装Swagger的步骤(以集成Swagger UI为例):
安装基础依赖
sudo apt update
sudo apt install -y nodejs npm
安装Swagger工具
sudo npm install -g swagger-ui-express swagger-jsdoc
创建Swagger配置文件
swagger.json
或swagger.yaml
,定义API接口信息(示例内容可参考)。集成到应用
const express = require('express');
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');
const app = express();
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
app.listen(3000, () => console.log('Server running on port 3000'));
启动服务并访问
node your-app.js
http://localhost:3000/api-docs
查看Swagger UI界面。可选步骤:
sudo npm install -g swagger-editor
启动后访问http://localhost:8080
编辑API文档。注:根据实际需求选择工具(如需生成静态文档,可使用swagger-codegen
),部分步骤需根据项目类型(如Python/Java)调整。