问题标签 [aglio]

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 回答
1899 浏览

node.js - aglio API 蓝图渲染安装错误

我正在尝试安装 aglio,https: //github.com/danielgtaylor/aglio,由于出现错误而无法继续前进。

我的服务器是cento OS 6.5,

我按照此处的说明安装了节点 js https://www.digitalocean.com/community/tutorials/how-to-install-and-run-a-node-js-app-on-centos-6-4-64bit

然后它显示另一个错误,因为找不到咖啡脚本 1.8.0。我将它安装为npm install -g coffee-script

所以请建议我如何摆脱这个错误。

这是有关错误的完整信息。

0 投票
0 回答
768 浏览

windows - 尝试使用 node.js 安装 aglio 时出错

我在我的 Windows 7 机器上运行 Node.js 0.10.36。我还安装了 grunt v0.4.5 和 grunt-cli v0.1.13。Python 是 2.7.3,Microsoft Visual Studio 是 2012。

我正在尝试在全球范围内安装 aglio。我运行的命令是

返回的错误如下

在此处输入图像描述

我一直在互联网上寻找一个好的解决方案,但我已经没有东西可以尝试了。主要建议是安装 Python(我已经完成)并将 Microsoft Visual Studio 设置为 2012(我也完成了)。

0 投票
1 回答
160 浏览

aglio - 生成HTML文件时输入参数?

我目前正在使用 aglio 为几个不同的服务组生成 API 规范。我现在面临的问题是我想将规范部署到多个环境(针对不同的消费者群体),因此显示的基本 URL 需要不同。

有没有办法为每个 HTML 文件生成发送一个基本 URL?

0 投票
1 回答
378 浏览

apiblueprint - API Blueprint + Aglio 中的数据抽象?

阅读API Blueprint specification,似乎设置为允许指定“数据结构”,例如:

  • 地址
    • 街道:100 Main Str. (字符串) - 街道地址
    • 邮编:77777-7777(字符串)-邮政编码

...

  • 顾客:
    • 句柄:mrchirpy(字符串)
    • 地址:(地址)

然后在模型中,引用数据结构:

  • 模型

    [顾客][]

似乎一切都设置为通过引用数据结构,它应该生成与端点一致的文档和示例。

但是,我似乎无法让它工作,也找不到使用“完全规范化数据抽象”的示例。我想定义一次我的数据结构,然后到处引用。看起来这可能是工具的问题,特别是我使用aglio作为渲染代理。

似乎所有这些都是折叠类型的东西,所以我很困惑,想知道我是否遗漏了一些东西,或者对这里可能发生的事情做出了错误的假设。

0 投票
1 回答
1206 浏览

rest - Aglio 不允许将 body 中的参数定义为参数

Aglio 是一种 API 蓝图渲染器,不允许将请求正文中的参数包含在端点规范的参数部分中。它抛出解析警告如下:

parameter '<some_parameter>' not specified in '<some_description>' its '<some_URI_template>' URI template (warning code 8)

复制此警告的示例 Markdown 是:

渲染不喜欢 'destination' 作为参数,因为它不在 URI 模板中。

我的问题是,这是该工具的一个缺点,还是 API 蓝图规范?另外,也许,REST 端点的定义不符合标准?

0 投票
3 回答
2471 浏览

markdown - 如何重用 API BluePrint 架构中的对象?

我创建了一个 API,它提供了一个名为“Thumbnail”(/thumbnails)的资源

另一方面,我有多个资源,其中包括该缩略图资源(如 /articles、/videos ...):

当我在 BluePrint markdown 中编写这些 Web 服务的模式时,我希望能够重用我为缩略图模式创建的模式,以免重复模式中的代码。我很喜欢 Trait 功能(https://github.com/apiaryio/api-blueprint/issues/47),但我不知道它是否符合我的需求,以及它是否适用于 aglio 和 dredd。

你知道在我的情况下最好的办法吗?

0 投票
1 回答
732 浏览

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

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

0 投票
1 回答
79 浏览

apiblueprint - ApiBlueprints 参数会产生像 Stripe 的错误“属性”这样的结果?

我是 Stripe 的新手,我想生成一个看起来像错误部分的“属性”部分的结果:https ://stripe.com/docs/api/curl#errors

它看起来像一个有两列的表,即使它不是一个表。

我不知道我怎么能做到这一点。

有关信息,我正在使用 Aglio 生成模板。

0 投票
1 回答
304 浏览

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

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

输出是。

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

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

0 投票
2 回答
236 浏览

apiblueprint - 混合请求/响应正文和数据结构

我想使用 aglio/api 蓝图为我们的新 API 创建一个很好的文档。

JSON 可能很大(有很多可选值),所以我想在正文中给出一个适当的用例,但也为 json 模式使用数据结构。但是,只要架构完全适合正文,生成的 HTML 就会向我抛出“Hello, world!”,因为我没有填写示例数据 - 但由于正文中有一个完整且有效的示例,我没想到 aglio 会创建 Hello World 输出。

作为参考,这就是我期望在生成的 htmls 正文中出现的内容:

这是实际出现的情况:

这就是原始的 api 蓝图:

那么,首先:这是一种有效的做事方式吗?你会推荐一种不同的方法吗?这是 aglio 中的错误吗,因为在 apiary 中它按我的意图工作?谢谢!