汽车库存GraphQL API：如何设计日期输入字段支持单日期与范围查询？

问题场景 #

我正在为汽车库存系统实现GraphQL API，系统存储车辆注册信息、入库日期（inDate）、出库日期（outDate）等数据，需要实现查询API来检索特定日期或日期范围（如一周、一个月）内入库/出库的车辆信息。现有Schema如下：

scalar Date

input QueryArguments {
  registration: String
  inDate: UnknownType
  outDate: UnknownType
}

type Query {
  automobiles(input: QueryArguments!): [Automobile]
}

type Automobile{
  registration: String
  inDate: Date
  outDate: Date
}

之前看到过用自定义DateRangeInput的方案，但单日期查询时需要把日期传入start或end字段，不够简洁：

input DateRangeInput {
  start: Date
  end: Date
}

通用解决方案：自定义组合输入类型 #

结合实际需求和Apollo GraphQL的能力，推荐使用组合式输入类型，同时支持多单一日期和日期范围查询，Schema设计如下：

scalar Date

# 日期范围输入类型
input DateRangeInput {
  start: Date!
  end: Date!
}

# 日期查询输入类型：支持多日期或范围二选一
input DateQueryInput {
  onDates: [Date]
  inRange: DateRangeInput
}

# 更新后的查询参数
input QueryArguments {
  registration: String
  inDate: DateQueryInput
  outDate: DateQueryInput
}

type Query {
  automobiles(input: QueryArguments!): [Automobile]
}

type Automobile{
  registration: String
  inDate: Date
  outDate: Date
}

方案说明 #

1. 多日期查询：通过onDates传入一个日期数组，可直接匹配多个特定日期的入库/出库记录
2. 日期范围查询：通过inRange传入start和end日期，匹配该区间内的记录
3. Resolver逻辑控制：在Resolver中需要实现限制逻辑，比如禁止同时传入onDates和inRange（避免查询歧义），或者根据业务需求支持组合查询

查询示例 #

• 单日期入库查询：

query {
  automobiles(input: {
    inDate: { onDates: ["2024-05-01"] }
  }) {
    registration
    inDate
  }
}

• 日期范围出库查询：

query {
  automobiles(input: {
    outDate: { inRange: { start: "2024-04-01", end: "2024-04-30" } }
  }) {
    registration
    outDate
  }
}

• 多日期入库查询：

query {
  automobiles(input: {
    inDate: { onDates: ["2024-05-01", "2024-05-10"] }
  }) {
    registration
    inDate
  }
}

这个方案虽然不如单一字段简洁，但能完美适配GraphQL的类型系统，同时满足多样化的日期查询需求，也是Apollo生态中常用的实践方式。

内容的提问来源于stack exchange，提问作者Abhishek