我正在尝试在 API 蓝图中记录查询参数,但我不完全确定我是否正确完成了操作。该资源如下所示:
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 的误解还是应该以其他方式记录查询参数?
你的蓝图完全没问题,问题是当前的 Apiary 文档没有正确处理 URI 参数。
您可以尝试一下吗新文档 http://blog.apiary.io/2014/03/21/Re-API-Design-for-Humans/出去?它应该正确处理 URI 参数。
Edit
正确的 URI 模板应该是:
http://baasar.apiary-mock.com/user/{appId}/{userId}{?force}
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)