Проверка схемы Fastify не работает. У меня что-то настроено неправильно? - PullRequest
Новая
       20

Проверка схемы Fastify не работает. У меня что-то настроено неправильно?

0 голосов
/ 24 января 2020

Я пытаюсь выяснить, почему проверка схемы не работает в 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"
}

Если я отправлю это тело, оно пройдет нормально. Как мне настроить его на сбой во всех этих случаях?

1 Ответ

0 голосов
/ 27 января 2020

Использование вашей схемы имеет несколько исправлений:

  • , если вы не установите код состояния 201, заданная вами схема ответа не будет работать. Используйте '2xx' или установите правильный код в reply объекте
  • , чтобы удалить поле, которого нет в схеме, вам нужно добавить 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'"
    }
    */

})
...