Tag: apiblueprint

npm包,主angular“未知访客types”

我试图通过protagonist (然后通过blueman )将我的API蓝图转换为邮差集合,但是当我使用主angular时,无论我做什么,我都会得到以下结果。 { "element": "parseResult", "content": [ { "element": "annotation", "meta": { "classes": [ "warning" ] }, "attributes": { "code": 4, "sourceMap": [ { "element": "sourceMap", "content": [] } ] }, "content": "Unknown visitor type" } ] } 我已经消除了从我的代码的可能性,因为我只是使用示例代码时得到这个结果: var result = protagonist.parseSync('# My API'); 我已经尝试了protagonist 1.2.6和1.3.0-pre.0,我得到了相同的结果。 它似乎来自这里 ,但我不明白是什么原因造成的。 系统信息 OS X – 10.11.4 […]

提供Node / JS REST API的文档

我正在寻找使用Node和Express构buildREST API,并且希望为它提供文档。 我不想手工制作,看起来有Swagger,RAML和Api Blueprint / Apiary等forms的解决scheme。 我真正喜欢的就是使用Swabbuckle或者微软提供的解决scheme,尽可能在.NET中使用API​​代码自动生成文档,但是通过强大的input和reflection使得它们成为可能。 对于JS世界来说,正确的select是使用Swagger / RAML / Api Blueprint标记来定义API,然后从中生成文档和脚手架服务器。 前者看似简单,但我对后者不太确定。 我所见过的所有这些选项的服务器代码生成看起来都非常有限。 需要有一些方法来将自动生成的代码与手动代码分开,以便定义可以很容易地更新,而且我也没有看到任何迹象或讨论。 这似乎不是一个不可逾越的问题(我比.NET更熟悉.NET,所以我可以很容易地错过了一些东西),并提到这个问题和解决scheme正在从以前的堆栈溢出问题一年前。 任何人都可以告诉我,如果我失踪/误解任何东西,如果有解决上述问题的存在?

通过代码注释生成API文档

我正在使用aglio来生成我的API文档。 我目前正在根据API蓝图规范为此编写原始降价。 我想知道是否有一种方法可以直接在代码中通过注释生成降价。 有谁知道有一种方法来做到这一点?