使用scala-jsonschema生成Json Schema时如何跳过指定字段？

关于andyglow/scala-jsonschema字段过滤的实现 #

你使用的这个库原生支持跳过Case Class指定字段，不需要换库，具体有两种实现方式：

方式1：使用内置注解实现（推荐） #

给需要跳过的字段添加@json.invisible注解即可，推导Schema时会自动忽略该字段，示例代码如下：

import json.annotations.invisible
import java.time.ZonedDateTime

case class Pizza(a: Int, b: String, @invisible c: ZonedDateTime)
val stringSchema: json.Schema[Pizza] = Json.schema[Pizza]
// 生成的Schema只会包含a、b两个字段

方式2：手动修改Schema（无需修改Case Class定义） #

如果你不能修改原始Case Class的代码，可以通过Schema的转换方法手动移除指定字段：

import json._
import json.Schema._

case class Pizza(a: Int, b: String, c: ZonedDateTime)
val rawSchema = Json.schema[Pizza]
val filteredSchema = rawSchema.asObject.removeField("c")

替代库推荐 #

如果上述方案不符合你的使用场景，可以考虑以下成熟的Scala JSON Schema生成库，均支持自定义字段过滤能力：

• Circe生态的circe-json-schema：配合circe-generic-extras使用，支持通过配置全局或单Case Class的字段排除规则，适合已经接入Circe序列化的项目
• Play JSON配套Schema生成工具：基于Play JSON的序列化配置推导Schema，可复用现有序列化逻辑中的字段过滤规则
• Tapir自带Schema推导能力：支持通过注解、自定义推导规则跳过字段，同时支持直接导出JSON Schema、OpenAPI文档等多种产物，适合Web服务类项目使用

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