API Blueprint参数名称未显示

Question

我是API蓝图的新手，请原谅我的天真。我正在尝试格式化一些参数，例如Aglio示例中给出的参数：

+ Parameters

    + name (optional, string, `alice`) ... Search for a user by name
    + joinedBefore (optional, string, `2011-01-01`) ... Search by join date
    + joinedAfter (optional, string, `2011-01-01`) ... Search by join date

但是，显示参数名称的所有内容都是参数的索引。以下是Atom API-Display软件包的显示：https://atom.io/packages/api-blueprint-preview。

如何让它显示参数的名称？

Answer 1

蓝图片段看起来不错。只是为了这个缘故 - 您可以共享用于定义相应资源的URI模板吗？ URI模板应包含以下内容：

{?name,joinedBefore,joinedAfter}

e.g。

# Resource [/resource{?name,joinedBefore,joinedAfter}]

但是蓝图看起来还不错，所以它可能是Aglio或预览包本身的问题。最好在https://github.com/danielgtaylor/aglio/issues?state=open或https://github.com/danielgtaylor/atom-api-blueprint-preview/issues检查并报告。