ex_json_schema 使用教程

项目介绍

ex_json_schema 是一个 Elixir 语言的 JSON Schema 验证器，完全支持 draft 4 规范，并且没有任何外部依赖。该项目在 GitHub 上开源，由 jonasschmidt 维护，拥有 360 颗星和 97 个 forks。

项目快速启动

安装

首先，将项目添加到你的 Mix 依赖中：

defp deps do
  [
    {:ex_json_schema, "~> 0.10.2"}
  ]
end

然后更新你的依赖：

$ mix deps.get

使用示例

以下是一个简单的使用示例，展示如何验证一个 JSON 对象：

# 定义一个 JSON Schema
schema = %{
  "type" => "object",
  "properties" => %{
    "name" => %{"type" => "string"},
    "age" => %{"type" => "integer"}
  },
  "required" => ["name"]
} |> ExJsonSchema.Schema.resolve()

# 定义一个 JSON 对象
json = %{"name" => "John", "age" => 30}

# 验证 JSON 对象
{:ok, _} = ExJsonSchema.Validator.validate(schema, json)

应用案例和最佳实践

应用案例

ex_json_schema 可以用于各种需要验证 JSON 数据的场景，例如：

• API 输入验证
• 配置文件验证
• 数据导入和导出验证

最佳实践

• 远程 Schema 加载：如果你的 Schema 存储在远程服务器上，可以使用以下配置来加载：

  config :ex_json_schema, :remote_schema_resolver, fn url ->
    HTTPoison.get!(url).body |> Jason.decode!()
  end
  

• 模块化验证：将验证逻辑封装在单独的模块中，以便于管理和测试。

典型生态项目

ex_json_schema 可以与其他 Elixir 项目结合使用，例如：

• Phoenix：用于验证 API 请求和响应。
• Ecto：用于验证数据库模型。
• Jason：用于 JSON 编码和解码。

通过这些生态项目的结合，可以构建出更加健壮和可靠的 Elixir 应用。