apiblueprint - 使用 API 蓝图记录查询参数

Question

我正在尝试在 API Blueprint 中记录查询参数，但我不完全确定我是否正确完成了它。资源看起来像这样:

DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}

该请求将停用用户，而以下内容将删除用户对象:

DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}?force=true

这是我为此的蓝图 Markdown :

## User [/user/{appId}/{userId}]
Handle user objects

+ Parameters
    + appId (required, number, `1`) ... Application ID (`appId`)
    + userId (required, number, `1`) ... Numeric `userId` of the User object to manage

### Remove an User [DELETE]
+ Parameters
    + force (optional, boolean, `false`) ... Set to `true` to remove instead of deactivate

+ Response 204

但是，当用 Apiary 渲染时，我只看到 force在参数列表中，但现在显示在示例 URL 中。这只是我误解了 GUI 还是应该以另一种方式记录查询参数？

Answer 1

您的蓝图非常好，问题是当前的 Apiary 文档没有正确处理 URI 参数。

你能不能试试new documentation出去？它应该正确处理 URI 参数。



编辑

正确的 URI 模板应该是:

http://baasar.apiary-mock.com/user/{appId}/{userId}{?force}