我正在尝试在 API Blueprint 中记录一个查询参数,但我不完全确定我是否做得正确。资源如下所示:
DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}
该请求将停用用户,而以下将删除用户对象:
DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}?force=true
这是我为此准备的蓝图降价:
## 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 还是应该以其他方式记录查询参数?