Fastify

Fluent Schema

在验证和序列化一文中，我们列明了使用 JSON schema 验证输入、优化输出时所有可用的参数。

现在，你可以使用 fluent-json-schema 来更简单地设置 JSON schema，并且复用常量。

基本设置

  1. const S = require('fluent-json-schema')
  3. // 你可以使用如下的一个对象，或查询数据库来获取数据
  4. const MY_KEYS = {
  5.   KEY1: 'ONE',
  6.   KEY2: 'TWO'
  7. }
  9. const bodyJsonSchema = S.object()
  10.   .prop('someKey', S.string())
  11.   .prop('someOtherKey', S.number())
  12.   .prop('requiredKey', S.array().maxItems(3).items(S.integer()).required())
  13.   .prop('nullableKey', S.mixed([S.TYPES.NUMBER, S.TYPES.NULL]))
  14.   .prop('multipleTypesKey', S.mixed([S.TYPES.BOOLEAN, S.TYPES.NUMBER]))
  15.   .prop('multipleRestrictedTypesKey', S.oneOf([S.string().maxLength(5), S.number().minimum(10)]))
  16.   .prop('enumKey', S.enum(Object.values(MY_KEYS)))
  17.   .prop('notTypeKey', S.not(S.array()))
  19. const queryStringJsonSchema = S.object()
  20.   .prop('name', S.string())
  21.   .prop('excitement', S.integer())
  23. const paramsJsonSchema = S.object()
  24.   .prop('par1', S.string())
  25.   .prop('par2', S.integer())
  27. const headersJsonSchema = S.object()
  28.   .prop('x-foo', S.string().required())
  30. const schema = {
  31.   body: bodyJsonSchema,
  32.   querystring: queryStringJsonSchema, // (或) query: queryStringJsonSchema
  33.   params: paramsJsonSchema,
  34.   headers: headersJsonSchema
  35. }
  37. fastify.post('/the/url', { schema }, handler)

复用

使用 fluent-json-schema，你可以简单且程序化地处理 schema，并通过 addSchema() 来复用它们。 正如验证和序列化一文所述，有两种方法来引用 schema。

以下是一些例子：

使用$ref：引用外部的 schema。

  1. const addressSchema = S.object()
  2.   .id('#address')
  3.   .prop('line1').required()
  4.   .prop('line2')
  5.   .prop('country').required()
  6.   .prop('city').required()
  7.   .prop('zipcode').required()
  9. const commonSchemas = S.object()
  10.   .id('https://fastify/demo')
  11.   .definition('addressSchema', addressSchema)
  12.   .definition('otherSchema', otherSchema) // 你可以任意添加需要的 schema
  14. fastify.addSchema(commonSchemas)
  16. const bodyJsonSchema = S.object()
  17.   .prop('residence', S.ref('https://fastify/demo#address')).required()
  18.   .prop('office', S.ref('https://fastify/demo#/definitions/addressSchema')).required()
  20. const schema = { body: bodyJsonSchema }
  22. fastify.post('/the/url', { schema }, handler)

替换方式：在验证阶段之前，使用共用 schema 替换某些字段。

  1. const sharedAddressSchema = {
  2.   $id: 'sharedAddress',
  3.   type: 'object',
  4.   required: ['line1', 'country', 'city', 'zipcode'],
  5.   properties: {
  6.     line1: { type: 'string' },
  7.     line2: { type: 'string' },
  8.     country: { type: 'string' },
  9.     city: { type: 'string' },
  10.     zipcode: { type: 'string' }
  11.   }
  12. }
  13. fastify.addSchema(sharedAddressSchema)
  15. const bodyJsonSchema = {
  16.   type: 'object',
  17.   properties: {
  18.     vacation: 'sharedAddress#'
  19.   }
  20. }
  22. const schema = { body: bodyJsonSchema }
  24. fastify.post('/the/url', { schema }, handler)

特别注意：你可以在 fastify.addSchema 方法里混用 $ref 和 替换方式。