- 确保已经使用Swagger Editor或者任何其他支持OpenAPI 3.0.2文档的工具来描述API。例如,使用Swagger UI显示的文档文件。下面的示例代码是一个最小的OpenAPI 3.0.2文档:
openapi: 3.0.2
info:
title: My API
version: 1.0.0
paths:
/test:
get:
description: Returns a greeting
responses:
'200':
description: A message
content:
application/json:
schema:
type: object
properties:
message:
type: string
- 安装 Swagger Request Validator模块:
npm i swagger-request-validator
- 在Node.js服务器应用程序中包含以下代码:
const express = require('express');
const app = express();
const { OpenApiValidator } = require('express-openapi-validator');
app.use(express.json());
// 必须在useRouter之前启用中间件
const openApiValidator = new OpenApiValidator({
apiSpec: './openapi.json',
});
app.use(
openApiValidator.router,
//检查请求是否符合规范
(err, req, res, next) => {
//处理OpenAPI验证错误
res.status(err.status).json({
error: {
name: err.name,
message: err.message,
status: err.status,
errors: err.errors,
},
});
},
);
app.get('/test', (req, res) => {
res.json({ message: 'Hello World!' });
});
app.listen(3000, () => {
console.log('Server started');
});
- 根据需要,向应用程序添加其他API路由和中间件。在这个例子中,服务器应用程序在路由"/test"上提供一个简单的JSON响应,以演示OpenAPI验证器