快速架构验证不起作用。我是否配置了错误的方式?



我试图弄清楚为什么模式验证在 Fastify 中不起作用。我有以下代码:

const postOptions = {
schema: { 
body: {
type: 'object',
properties: {
name: { type: 'string' },
parentId: { type: 'number' },
requiredKey: { foo: { type: 'string'} }
}
},
response: {
201: {
type: 'object',
properties: {
id: { type: 'number'},
name: { type: 'string'},
parentId: { type: 'number' }
}
}
}
}
}
fastify.post('/sponsor', postOptions, async (request, reply) => {
console.log(`POST /sponsor called`)
return { id: 2, name: 'Zenotis', parentId: 1 }
})

当我使用邮递员进行测试时,我可以随身体发送任何键和值,并且它可以通过正常。好像根本没有检查。响应也是如此。我正在使用 Fastify 版本 2.11.0

编辑:这是我发送的json正文:

{
"name": "Test",
"parentId": 5555555,
"foo": "bar"
}

以下是我期望失败的内容:

{
"myName": "the field is not name",
"parentID": "The D is capitalized and this is a string",
"bar": "where did this field come from, it's not foo"
}

如果我发送这个身体,它会很好。如何将其配置为在所有这些情况下失败?

您的架构使用有一些修复需要应用:

  • 如果未设置状态代码 201,则设置的响应架构将不起作用。在reply对象中使用'2xx'或设置正确的代码
  • 要删除不在架构中的字段,您需要添加additionalProperties
  • 如果未在架构中设置required字段,则所有字段都是可选的

这里有一个阻塞示例:


const fastify = require('fastify')()
const postOptions = {
schema: {
body: {
type: 'object',
additionalProperties: false, // it will remove all the field that is NOT in the JSON schema
required: [
'name',
'parentId',
'requiredKey'
],
properties: {
name: { type: 'string' },
parentId: { type: 'number' },
requiredKey: { foo: { type: 'string' } }
}
},
response: {
201: {
type: 'object',
properties: {
id: { type: 'number' },
name: { type: 'string' },
parentId: { type: 'number' }
}
}
}
}
}
fastify.post('/sponsor', postOptions, async (request, reply) => {
console.log('POST /sponsor called')
reply.code(201) // if you don't set the code 201, the response schema you set will not work
return request.body
})
fastify.inject({
method: 'POST',
url: '/sponsor',
payload: {
name: 'Test',
parentId: 5555555,
foo: 'bar'
}
}, (_, res) => {
console.log(res.json())
/* it will print
{
statusCode: 400,
error: 'Bad Request',
message: "body should have required property 'requiredKey'"
}
*/
})

最新更新