在Linux环境中,Swagger配置文件的编写通常遵循OpenAPI规范。以下是一个基本的Swagger配置文件示例,用于描述一个简单的RESTful API。
sudo apt-get install swagger-ui-express
swagger.json
的文件,用于存放Swagger配置信息。以下是一个简单的示例:{
"swagger": "2.0",
"info": {
"description": "这是一个简单的RESTful API示例",
"version": "1.0.0",
"title": "示例API"
},
"basePath": "/api",
"schemes": [
"http"
],
"paths": {
"/users": {
"get": {
"summary": "获取用户列表",
"responses": {
"200": {
"description": "成功获取用户列表",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/User"
}
}
}
}
},
"post": {
"summary": "创建新用户",
"parameters": [
{
"in": "body",
"name": "user",
"description": "用户对象",
"required": true,
"schema": {
"$ref": "#/definitions/User"
}
}
],
"responses": {
"201": {
"description": "成功创建新用户"
}
}
}
}
},
"definitions": {
"User": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
}
},
"required": [
"id",
"name",
"email"
]
}
}
}
这个配置文件描述了一个简单的用户管理API,包括获取用户列表和创建新用户的操作。
app.js
的文件,并添加以下内容: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 is running at http://localhost:3000');
});
node app.js
现在,你可以在浏览器中访问http://localhost:3000/api-docs
来查看和测试你的API。
请注意,这只是一个简单的示例。你可以根据你的需求扩展和修改Swagger配置文件,以满足你的API文档需求。更多关于OpenAPI规范和Swagger配置的信息,请参考官方文档。