当前位置:首页 > 文章列表 > Golang > Go问答 > 如何为尚未发布的 JSON 模式提供绝对 URL 的 $id?

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

来源:stackoverflow 2024-02-25 09:39:25 0浏览 收藏
推广推荐
免费电影APP ➜
支持 PC / 移动端,安全直达

最近发现不少小伙伴都对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学习网公众号!

版本声明
本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
分隔字符串使用 Golang 正则表达式分隔字符串使用 Golang 正则表达式
上一篇
分隔字符串使用 Golang 正则表达式
使用Go获取MongoDB中所有模型树子节点
下一篇
使用Go获取MongoDB中所有模型树子节点
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    3201次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    3414次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    3444次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    4552次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    3822次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码