能否通过express-openapi-validator读取自定义OpenAPI扩展?
实现方法
完全可以通过express-openapi-validator实现自定义扩展的读取,具体步骤如下:
1. 在OpenAPI文件中定义自定义扩展
按照你给出的示例,直接在operation节点下添加以x-开头的自定义字段即可:
/my-endpoint: get: operationId: processGetMyEndpoint x-eov-operation-handler: myController x-custom-extension: custom-value # 还可以添加更多自定义扩展,比如x-permission: admin
2. 在请求处理函数中获取自定义扩展
express-openapi-validator会将当前匹配的OpenAPI操作元数据挂载到req.openapi.operation对象上,所有自定义扩展都会被保留在这个对象里,直接读取即可:
function processGetMyEndpoint(req, res) { // 直接读取自定义扩展值 const customExtensionValue = req.openapi.operation['x-custom-extension']; // 在这里使用该值进行业务处理 console.log('自定义扩展值:', customExtensionValue); res.status(200).json({ result: 'success', customVal: customExtensionValue }); }
如果是使用控制器类的方式(通过x-eov-operation-handler指定的控制器),同样可以通过req对象获取:
// myController.js class MyController { processGetMyEndpoint(req, res) { const customVal = req.openapi.operation['x-custom-extension']; // 业务逻辑处理 res.send({ customVal }); } } module.exports = MyController;
补充说明
- 所有以
x-开头的字段都是OpenAPI规范允许的自定义扩展,express-openapi-validator会自动保留这些字段,无需额外配置。 - 社区里很多开发者用这种方式给接口添加额外元数据,比如权限控制标识、日志等级、限流规则等,是比较成熟的用法。
内容的提问来源于stack exchange,提问作者John Griffin
相关产品推荐
相关产品推荐

