api-blueprint如何为类集合和单类对象定义端点

Question

我有和端点返回一组联系人，它的端点是：.../api/v1/contact。 现在我有另一个端点，将返回单个接触，它的终点是：.../API/V1 /接触式ID =

68 ## Contacts Endpoint [/v1/api/Contact] 
69 ### Retrieve All Contacts [GET] 

154 ## Contact Endpoint [v1/api/Contact?id=HashID] 
155 ### Get single contact [GET] 

现在我得到了以下两个错误：

意外头块，预期一个组，资源或动作定义，例如'＃组'， '＃[]' 或 '＃' 线：154•API蓝图

行动方法 'GET' 已经为资源定义 '/ V1/API /联系' 线：155•API蓝图

Answer 1

我认为处理这种情况的最好方法是简单地将查询参数id设置为可选，并记录不同的行为。

不过，我会尽量避免有相同的端点做多件事情（返回联系人或所有联系人），所以你可能要定义两个端点：

/v1/api/Contacts

/v1/api/Contact/:id（一查询参数无论如何都很好）