如何为尚未发布的 JSON 模式提供绝对 URL 的 $id？

最近发现不少小伙伴都对Golang很感兴趣，所以今天继续给大家介绍Golang相关的知识，本文《如何为尚未发布的 JSON 模式提供绝对 URL 的 $id？》主要内容涉及到等等知识点，希望能帮到你！当然如果阅读本文时存在不同想法，可以在评论中表达，但是请勿使用过激的措辞~

我正在整理 json 模式，并且想使用 $ref 来干燥我的模式。我将有许多模式，每个模式都使用公共子模式。我想在发布模式之前对其进行单元测试，方法是编写单元测试，断言在给定某些输入的情况下，输入被视为有效或无效，使用我相信正确的 json 模式库（这样我只是测试我的模式）架构，而不是库）。

让我感到困惑的是，为了在发布模式之前加载它们（我想在本地运行测试和 ci/cd 期间执行此操作），我需要使用如下所示的相对本地路径： p>

"pet": { "$ref": "file://./schemas/components/pet.schema.json" }

这是因为该宠物架构尚未发布到 url。尚未通过自动化测试验证其正确性。这对于运行测试来说足够有效，而且对于打包到 docker 映像中也很有效，以便在应用程序启动时可以从磁盘加载架构。

但是，如果我在将顶级架构之一发布到绝对 url 后将其提供给某人（利用 $ref），那么它就不会加载到他们的程序中，因为我使用的路径有效仅用于我的单元测试。

我发现我必须使用绝对 url 来发布我的架构，以便它们能够在消费程序中使用。我最终发布了模式 https://mattwelke.github.io/go-jsonschema-ref-docker-example/schemas/person.1-0-0.schema.json 和 https://mattwelke.github.io/ go-jsonschema-ref-docker-example/schemas/components/pet.1-0-0.schema.json 这样。我通过编写程序测试了它们在消费程序中运行良好：

package main

import (
    "fmt"

    "github.com/xeipuuv/gojsonschema"
)

func main() {
    schemaloader := gojsonschema.newreferenceloader("https://mattwelke.github.io/go-jsonschema-ref-docker-example/schemas/person.1-0-0.schema.json")

    jsonstr := `
    {
        "name": "matt",
        "pet": {
            "name": "shady"
        }
    }
    `

    documentloader := gojsonschema.newstringloader(jsonstr)

    result, err := gojsonschema.validate(schemaloader, documentloader)
    if err != nil {
        panic(fmt.errorf("could not validate: %w", err))
    }

    if result.valid() {
        fmt.printf("the document is valid.\n")
    } else {
        fmt.printf("the document is not valid. see errors:\n")
        for _, desc := range result.errors() {
            fmt.printf("- %s\n", desc)
        }
    }
}

这导致了以下预期输出：

The document is valid.

所以我对这种“先有鸡还是先有蛋”的情况感到困惑。

只要我在发布之前没有对它们进行单元测试，我就能够发布可以使用的模式。

只要满足以下条件，我就能够对架构进行单元测试：

• 我不想以经过单元测试验证正确的形式发布它们。
• 我同意我的应用程序在启动时通过 https 加载它们，而不是从磁盘加载它们。我对此感到担心，因为我不希望网络服务器成为我的应用启动时的故障点。

我希望能够了解如何实现这两个目标。

正确答案

让我感到困惑的是，为了在发布模式之前加载它们（我想在本地运行测试和 CI/CD 期间执行此操作），我需要使用相对本地路径

您最初的假设是错误的。 $id 关键字中使用的 URI 可以是任意标识符——它们不需要通过指定位置的网络或磁盘进行解析。事实上，JSON Schema 实现假设在指定位置查找架构文档是错误的：它们必须支持能够在本地加载文档并将它们与指定标识符关联：

“$id”关键字通过其规范 URI 标识架构资源。

请注意，此 URI 是一个标识符，不一定是网络定位符。对于可网络寻址的 URL，模式不需要可从其规范 URI 下载。

source

如果模式是可网络寻址的 URL，则不需要从该地址下载模式，并且实现不应假设它们在遇到可网络寻址的 URI 时应该执行网络操作。

source

因此，您可以为架构文档提供您喜欢的任何标识符，例如您最终发布架构供公众使用时预期使用的 URI，并使用该标识符执行本地测试。

任何不支持这样做的实现都违反了规范，这应该作为错误报告给其维护者。

以上就是《如何为尚未发布的 JSON 模式提供绝对 URL 的 $id？》的详细内容，更多关于的资料请关注golang学习网公众号！