问题标签 [mson]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
5126 浏览

api - 尝试使用 API 蓝图中的数据结构来描述请求和响应

我正在尝试使用规范的新属性和数据结构部分使用 API 蓝图记录端点。

我的请求有效负载如下所示:

我的响应负载看起来像这样:

我尝试了以下 API 蓝图降价:

现在,当在 Apiary 中查看它时,它告诉我这是一个有效的 API 蓝图文档,但它不是 JSON 预览请求和响应的方式。像这样的结构甚至可以在 API 蓝图中表示并能够在 Apiary 中很好地呈现吗?

0 投票
1 回答
1239 浏览

apiblueprint - 实现所需描述的 apiblueprint 结构

我目前有这样的 API 蓝图,但我无法实现正确的渲染。

我的问题是:

  • 主要是我想有请求和响应有效负载的表。我想实现布局:“响应”-> 带有作为响应有效负载的 json 对象字段的表。如果我输入“+ Attributes”(请参阅​​我的蓝图),我设法让它显示出来,但是当你有一个 json 对象作为有效负载时,我不确定这是描述这种情况的正确方法。也许应该使用其他关键字?

  • 当使用描述为“+ SampleProperties(SamplePropertiesDTO)”的字段渲染表格时,它在渲染页面中显示为表格中的一行,作为对象类型的 SampleProperties,并且在渲染页面上找不到 SamplePropertiesDTO 的内容。然而,我将它内联或作为文档的单独部分存在,例如所有数据结构所在的位置。

  • 如果可能的话,我想单独显式地显示数据结构对象的表。目前数据限制部分不会以任何方式显示在屏幕上。我怎么能那样做?

0 投票
1 回答
1407 浏览

json - JSON 到蓝图/MSON

我还没有找到任何用于这种转换的工具,有没有人知道任何存在的。

目前,我有来自 Swagger 的 JSON 数据,我想将其转换为 Blueprint/MSON 以与 Apiary 一起使用,但我不确定这是否可行。任何建议都会非常有帮助,或者建议其他路线尝试将我的 API 加载到 Apiary 而无需手动编写它。

0 投票
2 回答
4172 浏览

json - MSON 中的对象嵌套数组在 Apiary.io 文档中为空

我想创建一个嵌套数组,其中包含 MSON 格式的对象,以与 API Blueprint 和 Apiary 一起使用。我的代码看起来是正确的,但是当我在 Apiary 中渲染它时,我没有得到预期的 JSON。

我要创建的示例:导航有多个类别。每个类别可以有多个子类别。每个类别和子类别都有一个名称。

我为此创建的 MSON:

我期望的 JSON 输出:

我在 Apiary 中得到的输出

0 投票
1 回答
895 浏览

apiblueprint - MSON 描述蓝图中的对象属性

我有一个类似于这里描述的问题。

我有一个如下所示的 JSON:

我正在尝试使用 MSON 描述属性,以呈现蓝图。但是,我在这方面并不成功。这是我的尝试:

任何人的想法?任何输入将不胜感激。

0 投票
1 回答
732 浏览

apiblueprint - 在 API 蓝图/MSON 中使用模式

我正在研究 API 蓝图中的新数据结构语法的可能性,尤其是 MSON。是否可以附加或指定类似模式(正则表达式)的东西?在这个主题上没有找到任何东西。

0 投票
1 回答
496 浏览

apiblueprint - API 蓝图中的 MSON 数组对象“未定义”错误

我们正在利用 Apiary.io 的 API 蓝图使用 HAL+JSON 开发一个新的 API。我们一直在蓝图本身的响应中使用 JSON。我正在测试改用 MSON,但遇到了数组对象的问题。

这是 API 蓝图代码。一切都很好,除了curies数组(朝向底部),它包含一个object.

对于该curies数组,JSON 格式的 API 蓝图输出返回:

当预期的 JSON 看起来像这样时:

据我从 MSON 规范中可以看出,curies数组和对象的语法是正确的。

希望获得类似 MSON 探索的人们的任何反馈。

0 投票
1 回答
1657 浏览

apiblueprint - 如何在 API 蓝图中定义枚举数组

我对参数部分的假设解决方案是

但它因语义错误而失败:

参数字段的示例值 [firstField, secondField] 不在其预期值列表中

0 投票
1 回答
815 浏览

jsonschema - MSON 指定日期时间

以下 MSON 如何输出具有“格式”:“日期时间”的模式,类似于下面所述?

女士:

获得的 Json Schema:

所需的模式(注意“格式”字段):

0 投票
1 回答
304 浏览

data-structures - 原始类型作为 API 蓝图的数据结构

我想使用原始类型来描述数据结构。像这样:

输出是。

所以缺少描述。我试图把描述放在不同的地方。我做了很多事情(不想谈论它们)。我还尝试将信息添加到枚举值,如下所示:

我不知道这个问题是处理 MSON 语法还是 Aglio 生成器。